Linee guida per la contribuzione

Questa pagina spiega come contribuire con modifiche al plugin a un livello sicuro per il pubblico. I nomi delle classi interne, le costanti interne e i riferimenti all'infrastruttura di rilascio privata non sono pubblicati qui.

Quando utilizzare questo documento

Leggi questo documento quando stai per:

• Aprire una pull request che risolve un bug, aggiunge una funzionalità o migliora la documentazione.
• Tradurre il plugin in una nuova lingua.
• Inviare una segnalazione di sicurezza.

Panoramica

I contributi sono accettati tramite pull request. Ogni modifica dovrebbe:

• Corrispondere alla struttura e alle convenzioni esistenti (vedi Coding Standards).
• Essere coperta da unit test quando possibile (vedi Testing Guide).
• Includere stringhe traducibili utilizzando il text domain del plugin (vedi Internationalization For Developers).
• Applicare la corretta sanificazione ed escaping (vedi Sanitization And Escaping) e rispettare il modello di sicurezza di alto livello (vedi Security And Capability Checks).
• Aggiornare la documentazione pertinente sotto docs/en/ quando cambiano i comportamenti visibili pubblicamente — e mantenere tale documentazione sicura per il pubblico.

Requisiti o prerequisiti

• Git installato localmente e un fork del repository.
• Le versioni di PHP e WordPress dichiarate nell'intestazione del plugin.
• Composer installato per le dipendenze di sviluppo (solo framework di test).
• Un'installazione locale di WordPress funzionante per convalidare le modifiche che vanno oltre la logica testabile tramite unit test (vedi Local Development Setup).

Istruzioni passo dopo passo

1. Fai il fork del repository e crea un feature branch.
2. Apporta la tua modifica. Segui la guida alla scrittura sicura per il pubblico per qualsiasi aggiornamento della documentazione: non aggiungere nomi di classi interne, chiavi di opzione, nomi di rotte REST/AJAX, nomi di hook cron, identificatori di capability/nonce o dettagli dell'infrastruttura di rilascio al set docs/ pubblicato.
3. Aggiungi o aggiorna gli unit test dove possibile.
4. Esegui la suite di test localmente prima di aprire la pull request.
5. Apri una pull request dal tuo branch. Descrivi la modifica, i test che hai eseguito e gli eventuali aggiornamenti della documentazione.

Segnalazioni di sicurezza

Se ritieni di aver scoperto un problema di sicurezza, non aprire una segnalazione pubblica. Contatta AD Promotion privatamente in modo che la segnalazione possa essere valutata e risolta prima della divulgazione.

Traduzioni

Se desideri contribuire con una traduzione, basa il tuo lavoro sul file POT del progetto sotto /languages e invia i tuoi file .po / .mo tramite il normale processo di pull request. Vedi Internationalization For Developers.

Avviso sulla documentazione pubblica. Questa pagina fornisce solo una panoramica di integrazione di alto livello. I dettagli di implementazione interna, le API private, i dettagli di archiviazione interna e l'infrastruttura di rilascio sensibile alla sicurezza sono gestiti separatamente e non fanno parte della documentazione pubblica.