Articles /

WordPress.org

eforturile actuale de documentare inline ale WordPress au început cu adevărat începând cu ciclul de lansare 3.7 și au luat avânt pe măsură ce inițiativa hook docs a progresat. Documentația inline sau inițiativa “inline docs” este un proiect hibrid, raportarea către CoreCore Core este setul de software necesar pentru a rula WordPress. Echipa de dezvoltare de bază construiește WordPress., Documentație, și Developer Hub Echipe.

ce este documentația inline? #Ce este documentația inline?

documentația Inline oferă atât informații necesare, cât și utile sub formă de comentarii inline, blocuri doc și multe altele în codul sursă al WordPress în sine.

documentația inline este analizată cu fiecare versiune, iar documentația respectivă este afișată în referința Codului la developer.wordpress.orgWordPress.org site-ul comunității în care codul WordPress este creat și împărtășit de utilizatori. Aici puteți descărca codul sursă pentru nucleul WordPress, pluginurile și temele, precum și locația centrală pentru conversațiile și organizarea comunității. https://wordpress.org/.

Top

cum să te implici #cum să te implici

documentația Inline este considerată documentație “tehnică”, deci va fi necesară o anumită familiaritate cu baza de cod WordPress – trebuie să înțelegeți codul pentru a scrie despre el.

1. Familiarizați-vă cu standardul de Documentare PHP, precum și cu instrucțiunile de formatare și sfaturile de documentare.

2. Configurați o copie locală a versiunii pentru dezvoltatori a bazei de cod WordPress folosind diferite vagabonzi vagabonzi (VVV). WordPress este versiunea folosind SVNSVN Apache Subversion (adesea abreviat SVN, după numele său de comandă svn) este un sistem de control al versiunilor și reviziilor software. Dezvoltatorii de Software folosesc Subversion pentru a menține versiunile actuale și istorice ale fișierelor, cum ar fi codul sursă, paginile web și documentația. Scopul său este de a fi un succesor în mare parte compatibil cu sistemul de versiuni concurente (CVS) utilizat pe scară largă. WordPress core și wordpress.org codul lansat este gestionat central prin SVN. https://subversion.apache.org/., dar puteți utiliza și GitGit Git este un sistem de control al versiunilor distribuite GRATUIT și open source, conceput pentru a gestiona totul, de la proiecte mici la foarte mari, cu viteză și eficiență. Git este ușor de învățat și are o amprentă mică, cu performanțe rapide. Cele mai moderne plugin și tema de dezvoltare se face cu acest sistem de control al versiunii. https://git-scm.com/. (link-ul VVV pentru modul de a face acest lucru).

3. Citiți deschiderea unui bilet pentru a afla cum să creați un TracTrac Trac este locul în care contribuitorii creează probleme pentru bug-uri sau cereri de caracteristici la fel ca GitHub.https://core.trac.wordpress.org/. bilet.

4. Crearea de patch-uri:

  • actualizați întotdeauna copia locală a WordPress trunk înainte de a edita fișierul și de a crea patch-uri. A se utiliza svn up sau git pull, după caz.
  • generați patch-ul din directorul rădăcină al WordPress SVN sau git checkout. De exemplu, svn diff dir/filename.php > function_name.diff.

5. Cum să trimiteți un patch

există un patch pentru a raporta eșecurile documentației inline și
de exemplu, #48303 este un astfel de patch pentru WordPress 5.4.

  • adăugați comentariu și atașați fișierul patch.

6. Puteți contribui, de asemenea, la bilete Trac legate de documente inline care au nevoie de iterație.

  • dacă un bilet este marcat needs-patch sau needs-refresh, este posibil ca patch-urile existente să necesite doar o retușare sau să fie actualizate în raport cu cel mai recent portbagaj. Fiecare pic ajută!

Top

puncte de contact #puncte de contact

pentru orice întrebări, accesați canalele #docs sau #core-docs în Slack.

Top

Resources #Resources

  • PHP Documentation standard
  • baza de date Hooks Adam Brown (util pentru indicii cu privire la @since versiunile de cârlige în WordPress temă și dezvoltare, cârlige sunt funcții care pot fi aplicate la o acțiune sau un filtru în WordPress. Acțiunile sunt funcții efectuate atunci când un anumit eveniment are loc în WordPress. Filtrele vă permit să modificați anumite funcții. Argumentele folosite pentru a agăța atât filtrele, cât și acțiunile arată la fel.)

Top

cum se deschide un nou bilet de document #cum se deschide un nou bilet de document

practic, există un bilet pentru a raporta eșecurile și îmbunătățirile documentației inline. Dar, dacă aveți nevoie creați un bilet nou din anumite motive, urmați pașii de mai jos:

  1. citiți deschiderea unui bilet pentru a afla cum să creați un bilet Trac.
  2. creați un nou bilet pe Core Trac pentru fișierul:
    • formate de titlu sugerate ar putea fi “corecție PHPDoc pentru path/to/file.php ” sau ” îmbunătățirea documentației pentru path / to / file.php”.
    • Tipul trebuie să fie defect (bug).
    • alocați biletul componentei cu care este asociat fișierul.
    • lăsați versiunea necompletată.
    • adăugați focalizarea docs făcând clic pe ea.
  3. încărcați patch-ul pe biletul Trac pe care l-ați creat și adăugați cuvântul cheie has-patch.
  4. asigurați-vă că lăsați un comentariu care descrie patch-ul nou încărcat. Simpla încărcare a patch-urilor nu declanșează o notificare pentru oricine urmărește biletul.

notă: modificările documentației nu ar trebui să se amestece cu modificările de cod (chiar și spațiile albe), cu excepția cazului în care biletul solicită în mod specific ambele.

Ultima actualizare: 26 octombrie 2019

Leave a Reply