Segnalazioni di Bug
Zenzic è un progetto attivamente mantenuto che cerchiamo costantemente di migliorare. Con un progetto di questa dimensione e complessità, possono verificarsi dei bug. Se pensi di aver scoperto un bug, puoi aiutarci inviando un'issue nel nostro issue tracker pubblico, seguendo questa guida.
Prima di creare un'issue
Puntiamo a mantenere basso il numero di issue aperte affrontando i bug tempestivamente. Prima di inviare una nuova issue, completa i seguenti passaggi.
Aggiorna all'ultima versione
È probabile che il bug che hai scoperto sia già stato corretto in una versione successiva. Prima di segnalare un'issue, assicurati di utilizzare l'[ultima versione] di Zenzic.
Verranno risolti solo i bug che si verificano nell'ultima versione di Zenzic.
Cerca soluzioni
Prima di creare una segnalazione di bug, fai una ricerca:
-
Cerca nella documentazione e cerca sezioni correlate al tuo problema.
-
Cerca nel nostro issue tracker, poiché un altro utente potrebbe aver già segnalato lo stesso problema.
Tieni traccia di tutti i termini di ricerca e i link pertinenti: ti serviranno nella segnalazione del bug.
Template dell'issue
Il nostro template per le issue è composto dalle seguenti sezioni:
-
Contesto opzionale
Titolo
Un buon titolo è breve e descrittivo — un riassunto esecutivo in una frase dell'issue.
| Esempio | |
|---|---|
| Chiaro | validate_same_page_anchors genera falso positivo su heading auto-generati |
| Vago | La validazione degli anchor non funziona |
| Inutile | Aiuto |
Contesto opzionale
Fornisci contesto aggiuntivo per aiutarci a capire cosa stavi cercando di fare. Non descrivere qui il bug.
Descrizione del bug
Fornisci un riassunto chiaro, focalizzato e conciso del bug. Segui questi principi:
-
Spiega il cosa, non il come — concentrati sul problema e sul suo impatto, non su come riprodurlo.
-
Sii breve e conciso — una o due frasi è l'ideale.
-
Un bug alla volta — crea issue separate per bug non correlati.
Link correlati
Condividi link a tutte le sezioni della documentazione rilevanti per il bug, oltre a qualsiasi issue correlata trovata durante la ricerca.
Riproduzione
Una riproduzione minimale è il cuore di ogni buona segnalazione di bug. Ci permette di ricreare istantaneamente le condizioni necessarie per trovare la causa principale.
Dopo aver creato la riproduzione, allega il file .zip direttamente all'issue.
Allega una riproduzione .zip invece di linkare a un repository.
Passi per riprodurre
Elenca i passaggi specifici da seguire quando esegui la riproduzione per osservare il bug. Mantieni i passaggi concisi e completi.
Checklist
Grazie per aver seguito la guida e aver creato una segnalazione di bug di alta qualità. La checklist assicura che tu abbia letto questa guida e ci abbia fornito tutto il necessario per aiutarti.
Pensiamo a tutto noi.