Articles /

WordPress.org

WordPress ‘ nåværende inline dokumentasjonsinnsats startet virkelig i 3.7-utgivelsessyklusen, og fikk fart da hook docs-initiativet utviklet seg. Inline documentation, eller “inline docs” – initiativet er et hybridprosjekt, rapportering Til CoreCore-Kjernen er settet med programvare som kreves for å kjøre WordPress. Kjerneutviklingsteamet bygger WordPress., Dokumentasjon og Utviklerhubteam.

Hva er innebygd dokumentasjon? # Hva er inline dokumentasjon ?

inline dokumentasjon gir både nødvendig og nyttig informasjon i form av inline-kommentarer, doc blokker, og mer innenfor kildekoden Til WordPress selv.

den innebygde dokumentasjonen analyseres med hver utgivelse, og at dokumentasjonen vises I Kodereferansen på developer.wordpress.orgWordPress.org fellesskapssiden Der WordPress-koden er opprettet og delt av brukerne. Det er her du kan laste ned kildekoden For WordPress kjerne, plugins og temaer, samt den sentrale plasseringen for samfunnssamtaler og organisasjon. https://wordpress.org/.

Topp

hvordan bli involvert #hvordan bli involvert

Inline dokumentasjon anses å være “teknisk” dokumentasjon, så noen kjennskap Til WordPress kodebase vil være nødvendig – du må forstå koden for å skrive om det.

1. Gjør deg kjent MED PHP Dokumentasjon Standard, samt formatering retningslinjer og dokumentere tips.

2. Sett opp en lokal kopi av utviklerversjonen Av WordPress-kodebasen ved Hjelp Av Varierende Vagrant Vagrants (VVV). Apache Subversion (ofte forkortet SVN, etter kommandonavnet svn) Er et versjons-og revisjonskontrollsystem for programvare. Programvareutviklere bruker Subversion til å vedlikeholde nåværende og historiske versjoner av filer som kildekode, nettsider og dokumentasjon. Målet er å være en mest kompatibel etterfølger til Det mye brukte Concurrent Versions System (CVS). WordPress kjerne og wordpress.org utgitt kode styres sentralt gjennom SVN. https://subversion.apache.org/., Men Du kan også bruke GitGit Git Er et gratis og åpen kildekode distribuert versjonskontrollsystem designet for å håndtere alt fra små til svært store prosjekter med fart og effektivitet. Git er lett å lære og har et lite fotavtrykk med lynrask ytelse. Mest moderne plugin og tema utvikling blir gjort med dette versjonskontrollsystemet. https://git-scm.com/. (VVV-lenken for hvordan du gjør det).

3. Les Åpne En Billett for å lære å lage En TracTrac Trac Er stedet der bidragsytere skape problemer for feil eller funksjonsforespørsler mye som GitHub.https://core.trac.wordpress.org/. billett.

4. Opprette oppdateringer:

  • oppdater alltid din lokale kopi Av WordPress trunk før du redigerer filen og lager oppdateringer. Bruk svn up eller git pull, etter behov.
  • Generer oppdateringen fra rotkatalogen til WordPress SVN ELLER Git-kassen. For eksempel svn diff dir/filename.php > function_name.diff.

5. Hvordan sende inn en patch

Det er en patch for å rapportere inline dokumentasjonsfeil og
for eksempel er #48303 en slik oppdatering For WordPress 5.4.

  • Legg Til Kommentar og legg ved oppdateringsfil.

6. Du kan også bidra til inline docs-relaterte trac-billetter som trenger iterasjon.

  • hvis en billett er merket needs-patch eller needs-refresh, er det mulig at den eksisterende oppdateringen(e) kanskje bare trenger en touch-up eller oppdateres mot den nyeste kofferten. Hver lille bit hjelper!

Topp

Kontaktpunkter # Kontaktpunkter

hvis du har spørsmål, kan du stikke innom kanalene #docs eller #core-docs I Slack.

Topp

Ressurser #Ressurser

  • PHP Documentation Standard
  • Adam Brown ‘ S Hooks Database (nyttig for hint på @since versjoner av hooksHooks I WordPress tema og utvikling, kroker er funksjoner som kan brukes på en handling eller Et Filter I WordPress. Handlinger er funksjoner som utføres når En bestemt hendelse oppstår I WordPress. Filtre lar deg endre visse funksjoner. Argumenter som brukes til å koble både filtre og handlinger ser det samme.)

Topp

slik åpner du ny dokumentbillett #slik åpner du ny dokumentbillett

I Utgangspunktet er det En billett for å rapportere feil og forbedringer i inline-dokumentasjonen. Men hvis du trenger å opprette ny billett av en eller annen grunn, følg trinnene nedenfor:

  1. Les Åpne En Billett for å lære å lage En Trac billett.
  2. Opprett en ny billett På Core Trac for filen:
    • Foreslåtte Tittelformater kan være “PHPDoc-korreksjon for sti / til / fil.php “eller” Forbedre dokumentasjonen for sti/til / fil.php”.
    • Typen skal være defekt (feil).
    • Tilordne billetten Til Komponenten filen er knyttet til.
    • La Versjonen være tom.
    • Legg til docs-Fokuset ved å klikke på det.
  3. Last opp din patch Til Trac billett du opprettet, og legge til søkeordet har-patch.
  4. legg igjen en kommentar som beskriver den nylig opplastede oppdateringen. Bare å laste opp oppdateringer utløser ikke et varsel for alle som ser på billetten.

Merk: Dokumentasjonsendringer bør ikke blandes med kodeendringer (selv whitespacing) med mindre billetten spesifikt krever begge deler.

Sist oppdatert: 26. oktober 2019

Leave a Reply