WordPress.org

WordPress ‘ huidige inline documentatie inspanningen echt begonnen in de 3.7 release cyclus, en kreeg momentum als het hook docs initiatief vorderde. De inline documentatie, of” inline docs ” initiatief is een hybride project, rapportage aan de CoreCore Core is de set van software die nodig is om WordPress uit te voeren. Het Core Development Team bouwt WordPress., Documentatie, en ontwikkelaar Hub teams.

Wat is inline documentatie? # Wat is inline documentatie?

Inline documentatie biedt zowel noodzakelijke als nuttige informatie in de vorm van inline-opmerkingen, doc-blokken en meer binnen de broncode van WordPress zelf.

de inline documentatie wordt ontleed met elke release, en die documentatie wordt weergegeven in de Codeverwijzing op developer.wordpress.orgWordPress.org de community site waar WordPress code wordt gemaakt en gedeeld door de gebruikers. Dit is waar u de broncode voor WordPress core, plugins en thema ‘ s, evenals de centrale locatie voor de gemeenschap gesprekken en organisatie kunt downloaden. https://wordpress.org/.

Top

How to get involved # How to get involved

Inline documentatie wordt beschouwd als” technische ” documentatie, dus enige bekendheid met de WordPress codebase zal nodig zijn – je moet de code begrijpen om erover te schrijven.

1. Maak kennis met de PHP documentatie standaard, evenals de opmaak richtlijnen en documenteren tips.

2. Het opzetten van een lokale kopie van de ontwikkelaar versie van de WordPress codebase met behulp van variërende Vagrant Vagrants (VVV). WordPress is versiebeheer met behulp van SVNSVN Apache Subversion (vaak afgekort SVN, na de opdrachtnaam svn) is een software versiebeheer en revisie controlesysteem. Softwareontwikkelaars gebruiken Subversion om actuele en historische versies van bestanden te onderhouden, zoals broncode, webpagina ‘ s en documentatie. Het doel is om een grotendeels compatibele opvolger te zijn van het veelgebruikte Concurrent Versions System (CVS). WordPress core en de wordpress.org vrijgegeven code worden allemaal centraal beheerd via SVN. https://subversion.apache.org/. maar je kunt ook GitGit gebruiken Git is een gratis en open source gedistribueerd versiebeheersysteem ontworpen om alles van kleine tot zeer grote projecten met snelheid en efficiëntie af te handelen. Git is makkelijk te leren en heeft een kleine footprint met razendsnelle prestaties. De meeste moderne plugin en thema ontwikkeling wordt gedaan met dit versiebeheersysteem. https://git-scm.com/. (de VVV link voor hoe dat te doen).

3. Lees een Ticket openen om te leren hoe je een TracTrac maakt Trac is de plek waar bijdragers problemen creëren voor bugs of feature requests zoals GitHub.https://core.trac.wordpress.org/. ticket.

4. Patches aanmaken:

• update altijd uw lokale kopie van WordPress trunk voor het bewerken van het bestand en het maken van patches. Gebruik svn up of git pull, naargelang het geval.
• Genereer de patch vanuit de root directory van uw WordPress SVN of Git checkout. Bijvoorbeeld svn diff dir/filename.php > function_name.diff.

5. Hoe een patch

in te dienen er is één patch om de fouten in de inline documentatie te melden en
bijvoorbeeld, #48303 is een dergelijke patch voor de WordPress 5.4.

• commentaar toevoegen en patchbestand toevoegen.

6. U kunt ook bijdragen aan inline docs-gerelateerde Trac tickets die iteratie nodig hebben.

• als een ticket is gemarkeerd behoeften-patch of behoeften-refresh, is het mogelijk dat de bestaande patch(en) alleen een touch-up nodig hebben of worden ververst tegen de nieuwste trunk. Elk klein beetje helpt!

Top

contactpunten #contactpunten

voor vragen, pop door de #docs of # core-docs kanalen in Slack.

Top

Resources # Resources

• PHP Documentation Standard
• Adam Brown ‘ s Hooks Database (handig voor hints over de @since versies van hooksHooks in WordPress theme and development, hooks zijn functies die kunnen worden toegepast op een actie of een Filter in WordPress. Acties zijn functies die worden uitgevoerd wanneer een bepaalde gebeurtenis zich voordoet in WordPress. Met Filters kunt u bepaalde functies wijzigen. Argumenten die worden gebruikt om zowel filters als acties te haken, zien er hetzelfde uit.)

Top

hoe opent u een nieuw documentticket #hoe opent u een nieuw documentticket

in principe is er één ticket om fouten en verbeteringen in de inline documentatie te melden. Maar als u om de een of andere reden een nieuw ticket moet maken, volgt u onderstaande stappen:

1. lees het openen van een Ticket om te leren hoe u een Trac-ticket maakt.
2. Maak een nieuw ticket aan op Core Trac voor het bestand:
   • voorgestelde Titelformaten kunnen ” PHPDoc correctie voor pad / naar / bestand.php “of” verbeter documentatie voor pad / naar / bestand.php”.
   • het Type moet defect (bug) zijn.
   • wijs het ticket toe aan de Component waarmee het bestand is geassocieerd.
   • laat de versie leeg.
   • voeg de docs Focus toe door erop te klikken.
3. Upload uw patch naar het Trac-ticket dat u hebt gemaakt en voeg de keyword has-patch toe.
4. laat een opmerking achter die uw nieuw geüploade patch beschrijft. Het uploaden van patches leidt niet tot een melding voor iedereen die naar het ticket kijkt.

opmerking: wijzigingen in de documentatie mogen niet samengaan met wijzigingen in de code (zelfs witteklassen), tenzij het ticket specifiek beide aanroept.

laatst bijgewerkt: 26 oktober 2019