Articles /

WordPress.org

WordPress’ nuvarande inline dokumentationsinsatser startade verkligen i 3.7-utgivningscykeln och fick fart när hook docs-initiativet utvecklades. Inline documentation, eller” inline docs ” – initiativet är ett hybridprojekt, rapportering till CoreCore Core är den uppsättning programvara som krävs för att köra WordPress. Kärnutvecklingsteamet bygger WordPress., Dokumentation och utvecklare Hub Team.

Vad är inline dokumentation? # Vad är inline dokumentation?

Inline-dokumentation ger både nödvändig och användbar information i form av inline-kommentarer, doc-block och mer inom källkoden för WordPress själv.

den inbyggda dokumentationen tolkas med varje utgåva, och den dokumentationen visas i Kodreferensen på developer.wordpress.orgWordPress.org community-webbplatsen där WordPress-kod skapas och delas av användarna. Det är här du kan ladda ner källkoden för WordPress core, plugins och teman samt den centrala platsen för samhällssamtal och organisation. https://wordpress.org/.

topp

hur man engagerar sig #hur man engagerar sig

Inline dokumentation anses vara “teknisk” dokumentation, så viss förtrogenhet med WordPress – kodbasen kommer att vara nödvändig-du måste förstå koden för att skriva om den.

1. Bekanta dig med PHP-Dokumentationsstandarden, samt formateringsriktlinjerna och dokumenteringstips.

2. Ställ in en lokal kopia av utvecklarversionen av WordPress-kodbasen med varierande Vagrant Vagrants (VVV). WordPress är versionshantering med SVNSVN Apache Subversion (ofta förkortat SVN, efter dess kommandonamn svn) är en programvara versionshantering och revisionskontrollsystem. Programutvecklare använder Subversion för att behålla aktuella och historiska versioner av filer som källkod, webbsidor och dokumentation. Dess mål är att vara en mest kompatibel efterträdare till det allmänt använda Concurrent Versions System (CVS). WordPress core och wordpress.org släppt kod hanteras alla centralt via SVN. https://subversion.apache.org/., men du kan också använda GitGit Git är ett gratis och open source distribuerat versionshanteringssystem utformat för att hantera allt från små till mycket stora projekt med snabbhet och effektivitet. Git är lätt att lära sig och har ett litet fotavtryck med blixtsnabb prestanda. De flesta moderna plugin-och temautveckling görs med detta versionskontrollsystem. https://git-scm.com/. (VVV-länken för hur man gör det).

3. Läs öppna en biljett för att lära dig hur du skapar en TracTrac Trac är den plats där bidragsgivare skapar problem för buggar eller funktionsförfrågningar som GitHub.https://core.trac.wordpress.org/. Biljettservice.

4. Skapa patchar:

  • uppdatera alltid din lokala kopia av WordPress trunk innan du redigerar filen och skapar patchar. Använd svn up eller git pull, beroende på vad som är lämpligt.
  • generera korrigeringsfilen från rotkatalogen på din WordPress SVN eller Git kassan. Till exempel svn diff dir/filename.php > function_name.diff.

5. Hur man skickar in en patch

det finns en patch för att rapportera inline-dokumentationsfel och
till exempel är #48303 en sådan patch för WordPress 5.4.

  • Lägg till kommentar och bifoga patchfil.

6. Du kan också bidra till inline docs-relaterade Trac-biljetter som behöver iteration.

  • om en biljett är märkt needs-patch eller needs-refresh, är det möjligt att den befintliga korrigeringsfilen kanske bara behöver en touch-up eller uppdateras mot den senaste stammen. Varje liten bit hjälper!

topp

kontaktpunkter #kontaktpunkter

för eventuella frågor, pop av #docs eller #core-docs kanaler i Slack.

topp

Resurser #resurser

  • PHP Documentation Standard
  • Adam Browns krokar databas (användbar för tips på @since versioner av hooksHooks i WordPress tema och utveckling, krokar är funktioner som kan tillämpas på en åtgärd eller ett Filter i WordPress. Åtgärder är funktioner som utförs när en viss händelse inträffar i WordPress. Filter låter dig ändra vissa funktioner. Argument som används för att ansluta både filter och åtgärder ser likadana ut.)

Top

så här öppnar du nytt dokumentbiljett #så här öppnar du nytt dokumentbiljett

i grund och botten finns det en biljett för att rapportera inline-dokumentationsfel och förbättringar. Men, om du behöver skapa ny biljett av någon anledning, följ stegen nedan:

  1. Läs öppna en biljett för att lära dig hur du skapar en Trac-biljett.
  2. skapa en ny biljett på Core Trac för filen:
    • föreslagna Titelformat kan vara ” PHPDoc-korrigering för sökväg/till/fil.php “eller” förbättra dokumentationen för sökväg / till / fil.php”.
    • typen ska vara defekt (bugg).
    • tilldela biljetten till komponenten filen är associerad med.
    • lämna versionen tom.
    • Lägg till docs fokus genom att klicka på den.
  3. Ladda upp din patch till Trac-biljetten du skapade och Lägg till nyckelordet has-patch.
  4. se till att lämna en kommentar som beskriver din nyligen uppladdade patch. Att bara ladda upp patchar utlöser inte ett meddelande för alla som tittar på biljetten.

Obs: Dokumentationsändringar bör inte blandas med kodändringar (även blanksteg) om inte biljetten specifikt kräver båda.

Senast uppdaterad: 26 oktober 2019

Leave a Reply