Un buon bug report

Un buon bug report

È uscita la versione 4.6 beta di KDE, non si possono aggiungere né nuovo codice né nuove stringhe, quindi è ora di fare debug cioè individuare i problemi per riuscire a sistemarli prima che la versione finale 4.6 di KDE venga rilasciata ufficialmente.

Per questo motivo, è richiesta la collaborazione di tutti per testare e segnalare bug, un lavoro importantissimo in un progetto, specialmente se Open Source, che permette a chiunque di partecipare attivamente alla sua buona riuscita.

Nel blog di Annma si riportano alcuni suggerimenti su come scrivere dei buoni bug report:

  • Scrivete in inglese: se vi può essere d’aiuto potete cambiare le impostazioni di ogni applicazione dal menu Aiuto. L’inglese è la lingua ufficiale del team di sviluppo e come lingua ufficiale.
  • Siate specifici: è importante non mescolare più di un problema nello stesso bug report, perché è più semplice trovare i duplicati ed è un modo ordinato di risolvere i problemi, anche per gli sviluppatori.
  • Siate chiari: spiegate i passi che portano ad ottenere il bug, in modo che anche gli sviluppatori possano riprodurlo facilmente, altrimenti il bug report sarà inutile e non sarà possibile risolvere il problema che avete individuato.
  • Inserite screenshot: molte volte, un’immagine è meglio di molte parole, quindi allegate uno screenshot (ad esempio, realizzato con KSnapShot) per spiegare meglio quale sia il problema. Non linkate un sito esterno in cui avete caricato l’immagine, perché può scadere e, nel tempo, non essere più reperibile. Usate il link per gli allegati che si trova in basso sulla schermata dei bug report.
  • Inserite i backtrace copiandoli e incollandoli all’interno di un commento del bug report (non allegatelo come file di testo), perché in questo modo i duplicati sono più facili da individuare.
  • Separate i fatti dalle speculazioni, descrivete quello che succede e basta, così il lavoro per gli sviluppatori sarà più semplice. Per un problema di design inserite un mokup se possibile.

In ogni caso, i punti fondamentali sono la chiarezza e i dettagli delle informazioni che descrivono il problema.

Qualche mese fa ho tradotto la guida per i crash in italiano:
http://techbase.kde.org/Development/Tutorials/Debugging/How_to_create_useful_crash_reports_(it)