WordPress.org

WordPress’ current inline documentation efforts really started starting in the 3.7 release cycle, and got momentum as the hook docs initiative procedure. Inline documentation, tai “inline docs” aloite on hybridi projekti, raportointi CoreCore Core on joukko ohjelmistoja tarvitaan ajaa WordPress. Ydinkehitystiimi rakentaa WordPress., Dokumentointi, ja Kehittäjä Hub joukkueet.

mitä on inline-dokumentaatio? #Mikä on inline-dokumentaatio?

Inline-dokumentaatio tarjoaa sekä tarpeellista että hyödyllistä tietoa inline-kommenttien, doc-estojen ja muiden WordPressin lähdekoodiin sisältyvien tietojen muodossa.

inline-dokumentaatio jäsennetään jokaisen julkaisun yhteydessä, ja kyseinen dokumentaatio näkyy koodiviitteessä osoitteessa developer.wordpress.orgWordPress.org yhteisö sivusto, jossa WordPress koodi luodaan ja jaetaan käyttäjien. Tässä voit ladata lähdekoodin WordPress core, plugins ja teemoja sekä keskeinen sijainti yhteisön keskusteluja ja organisaatio. https://wordpress.org/.

Top

How to get involved #How to get involved

Inline documentation is considered to be “technical” documentation, so some familiarity with the WordPress codebase will be necessary – you have to understand the code to write about it.

1. Tutustu PHP-Dokumentointistandardiin sekä muotoiluohjeisiin ja dokumentointivihjeisiin.

2. Perustaa paikallisen kopion Kehittäjä versio WordPress codebase käyttäen vaihtelevia Vagrant Vagrant (VVV). WordPress on versiointi käyttäen SVNSVN Apache Subversion (usein lyhennetään SVN, sen komentonimi svn) on ohjelmiston versiointi-ja versionhallintajärjestelmä. Ohjelmistokehittäjät käyttävät Subversionia tiedostojen, kuten lähdekoodin, verkkosivujen ja dokumentaation, nykyisten ja historiallisten versioiden ylläpitämiseen. Sen tavoitteena on olla enimmäkseen yhteensopiva seuraaja laajalti käytetylle Concurrent Versions System (CVs) – järjestelmälle. WordPress ydin ja wordpress.org julkaistut koodit hallinnoidaan keskitetysti SVN: n kautta. https://subversion.apache.org/., mutta voit myös käyttää GitGit Git on ilmainen ja avoimen lähdekoodin hajautettu versionhallintajärjestelmä, joka on suunniteltu käsittelemään kaikkea pienistä erittäin suuriin projekteihin nopeasti ja tehokkaasti. Git on helppo oppia ja sillä on pieni jalanjälki salamannopealla suorituskyvyllä. Nykyaikaisin plugin ja teema kehitystä tehdään tällä versionhallintajärjestelmä. https://git-scm.com/. (VVV linkki, Miten se tehdään).

3. Lue Lipun avaaminen oppiaksesi luomaan TracTrac Trac on paikka, jossa avustajat luovat ongelmia bugeille tai ominaisuuspyynnöille, aivan kuten GitHub.https://core.trac.wordpress.org/. lippu.

4. Luodaan paikkoja:

• päivitä aina paikallinen kopio WordPress trunk ennen tiedoston muokkaamista ja laastarien luomista. Käytä tarvittaessa svn up tai git pull.
• luo paikkaus WordPress SVN – tai Git checkout-ohjelman juurihakemistosta. Esimerkiksi svn diff dir/filename.php > function_name.diff.

5. Miten lähettää laastari

on yksi laastari ilmoittaa inline dokumentaation epäonnistumisia ja
esimerkiksi #48303 on tällainen laastari WordPress 5.4.

• Lisää kommentti ja liitä paikkatiedosto.

6. Voit myös osallistua inline docs liittyvät Trac liput, jotka tarvitsevat iterointia.

• jos lipussa on merkintä needs-patch tai needs-refresh, on mahdollista, että olemassa oleva laastari(es) tarvitsee vain korjauksen tai päivittyy viimeisintä tavaratilaa vasten. Jokainen pikkuinen auttaa!

Top

Points of contact #Points of contact

for any questions, pop by the #docs or #core-docs channels in Slack.

Top

Resources #Resources

• PHP Documentation Standard
• Adam Brown ‘ s Hooks Database (hyödyllisiä vihjeitä @since versioista Hookshooks in WordPress theme and development, koukut ovat funktioita, joita voidaan soveltaa johonkin toimeen tai suodattimeen WordPressissä. Toiminnot ovat toimintoja, jotka suoritetaan, kun tietty tapahtuma tapahtuu WordPress. Suodattimilla voi muokata tiettyjä toimintoja. Sekä suodattimien että toimintojen kytkemiseen käytetyt argumentit näyttävät samoilta.)

Top

How to open new document ticket #How to open new document ticket

periaatteessa on yksi lippu, jolla voi ilmoittaa inline-dokumentaation epäonnistumisista ja parannuksista. Mutta, jos tarvitset luoda uusi lippu jostain syystä, seuraa alla vaiheet:

1. Lue avaamalla lippu oppia luomaan Trac lippu.
2. Luo uusi lippu Core Trac-tiedostoon:
   • ehdotetut Otsikkomuodot voisivat olla ” PHPDoc correction for path/to / file.php ” tai ” parantaa path/to / file dokumentointia.php”.
   • tyypin tulee olla vika (bug).
   • Anna lippu sille komponentille, johon tiedosto liittyy.
   • jätä versio tyhjäksi.
   • lisää docs-tarkennus klikkaamalla sitä.
3. Lataa paikkasi luomaasi Trac-lippuun ja lisää avainsana has-patch.
4. muista jättää kommentti, jossa kuvaillaan juuri ladattua paikkaasi. Pelkkä paikkausten lataaminen ei aiheuta ilmoitusta kenellekään lippua katsovalle.

Huomautus: Dokumentaatiomuutokset eivät saa sekoittua koodimuutoksiin (edes välilyönnit), ellei lipussa erikseen vaadita molempia.

päivitetty: 26. lokakuuta 2019