WordPress.org

Gli attuali sforzi di documentazione in linea di WordPress sono davvero iniziati a partire dal ciclo di rilascio 3.7 e hanno guadagnato slancio con il progredire dell’iniziativa hook docs. L’iniziativa inline documentation o” inline docs ” è un progetto ibrido, il reporting al Core CoreCore è l’insieme di software necessario per eseguire WordPress. Il team di sviluppo principale costruisce WordPress., Documentazione e team di Hub di sviluppo.

Che cos’è la documentazione in linea? # Che cos’è la documentazione in linea?

La documentazione inline fornisce informazioni sia necessarie che utili sotto forma di commenti inline, blocchi doc e altro ancora all’interno del codice sorgente di WordPress stesso.

La documentazione in linea viene analizzata con ogni rilascio e tale documentazione viene visualizzata nel Riferimento al codice developer.wordpress.orgWordPress.org Il sito della comunità in cui il codice WordPress viene creato e condiviso dagli utenti. Qui è possibile scaricare il codice sorgente per WordPress core, plugin e temi, nonché la posizione centrale per le conversazioni e l’organizzazione della comunità. https://wordpress.org/.

Top

How to get involved #How to get involved

La documentazione in linea è considerata una documentazione “tecnica”, quindi sarà necessaria una certa familiarità con la base di codice di WordPress – devi capire il codice per scriverlo.

1. Familiarizzare con lo standard di documentazione PHP, così come le linee guida di formattazione e suggerimenti per la documentazione.

2. Impostare una copia locale della versione per sviluppatori della base di codice WordPress utilizzando Vari Vagrant Vagrants (VVV). WordPress è versioning utilizzando SVNSVN Apache Subversion (spesso abbreviato SVN, dopo il suo nome di comando svn) è un sistema di controllo delle versioni e delle revisioni del software. Gli sviluppatori di software utilizzano Subversion per mantenere le versioni attuali e storiche di file come codice sorgente, pagine web e documentazione. Il suo obiettivo è quello di essere un successore per lo più compatibile con il sistema di versioni concorrenti ampiamente utilizzato (CVS). Centro di WordPress e il wordpress.org il codice rilasciato è gestito centralmente tramite SVN. https://subversion.apache.org/., ma Lei può anche usare GitGit Git è un sistema di controllo di versione distribuito fonte libero e aperto progettato per trattare tutto da piccoli a progetti molto grandi con velocità ed efficienza. Git è facile da imparare e ha un ingombro ridotto con prestazioni fulminee. La maggior parte dei plugin moderni e lo sviluppo del tema è stato fatto con questo sistema di controllo della versione. https://git-scm.com/. (il link VVV per come farlo).

3. Leggi Aprire un ticket per imparare a creare un TracTrac Trac è il luogo in cui i contributori creano problemi per bug o richieste di funzionalità molto simili a GitHub.https://core.trac.wordpress.org/. biglietto.

4. Creazione di patch:

• Aggiorna sempre la tua copia locale del trunk di WordPress prima di modificare il file e creare patch. Usare svn up o git pull, a seconda dei casi.
• Genera la patch dalla directory principale del tuo WordPress SVN o Git checkout. Ad esempio, svn diff dir/filename.php > function_name.diff.

5. Come inviare una patch

Esiste una patch per segnalare gli errori di documentazione in linea e
Ad esempio, #48303 è tale patch per WordPress 5.4.

• Aggiungi commento e allega file patch.

6. Puoi anche contribuire ai ticket Trac relativi ai documenti in linea che necessitano di iterazione.

• Se un ticket è contrassegnato con needs-patch o needs-refresh, è possibile che le patch esistenti richiedano solo un ritocco o vengano aggiornate rispetto all’ultimo trunk. Ogni piccolo aiuto!

Top

Punti di contatto #Punti di contatto

Per qualsiasi domanda, pop dai canali #docs o #core-docs in Slack.

Top

Resources #Resources

• PHP Documentation Standard
• Database di Hooks di Adam Brown (utile per suggerimenti sulle versioni @since di Hookshook Nel tema e nello sviluppo di WordPress, gli hooks sono funzioni che possono essere applicate a un’azione o un filtro in WordPress. Le azioni sono funzioni eseguite quando si verifica un determinato evento in WordPress. I filtri consentono di modificare determinate funzioni. Gli argomenti utilizzati per agganciare sia i filtri che le azioni hanno lo stesso aspetto.)

Top

Come aprire un nuovo documento ticket #Come aprire un nuovo documento ticket

Fondamentalmente, c’è un biglietto per segnalare i guasti e i miglioramenti della documentazione in linea. Ma, se hai bisogno di creare un nuovo ticket per qualche motivo, segui i passaggi seguenti:

1. Leggi Apertura di un biglietto per imparare a creare un biglietto Trac.
2. Crea un nuovo ticket su Core Trac per il file:
   • I formati di titolo suggeriti potrebbero essere “Correzione PHPDoc per path/to/file.php ” o ” Migliorare la documentazione per il percorso / a / file.PHP”.
   • Il Tipo dovrebbe essere defect (bug).
   • Assegna il ticket al Componente a cui è associato il file.
   • Lascia la versione vuota.
   • Aggiungi il Focus documenti facendo clic su di esso.
3. Carica la tua patch sul ticket Trac creato e aggiungi la parola chiave has-patch.
4. Assicurati di lasciare un commento che descriva la patch appena caricata. Il semplice caricamento delle patch non attiva una notifica per chiunque guardi il biglietto.

Nota: le modifiche alla documentazione non devono essere mescolate con le modifiche al codice (anche con spazi bianchi) a meno che il ticket non richieda specificamente entrambi.

Ultimo aggiornamento: 26 ottobre 2019