Come segnalare un bug

L’obiettivo di questo documento è di fornire istruzioni passo dopo passo per segnalare un bug su Fedora.

Un bug del software non deve essere necessariamente un crash del software. Qualsiasi comportamento non desiderato che si è notati nel software può essere segnalato come un bug. Il manutentore del pacchetto può di conseguenza leggere la segnalazione e decidere la miglior cosa da fare.

Qualsiasi utente dovrebbe compilare bug: tutti gli utenti sono incoraggiati a segnalare bug che incontrano. Segnalare i bug non è un’attività limitata solo ai sviluppatori software.

Terminologia

Ci sono alcuni termini che sono utilizzati in questo documento:

  • Bug: Un bug è un qualsiasi comportamento indesiderato o inatteso che appare in un software.

  • Tracciatore di bug: È il sistema di tracciamento di Fedora raggiungibile a https://bugzilla.redhat.com.

  • Pacchetto: Ogni software disponibile su Fedora ha un nome di pacchetto formale che è utilizzato dal tracciatore di bug e da altri strumenti dell’infrastruttura. I pacchetti possono essere cercati utilizzando Fedora dist-git.

  • Manutentore: Un volontario che tiene cura ti un pacchetto software fornito su Fedora. Ci si riferisce a loro come "manutentori dei pacchetti". Tengono traccia dei bug, aiutano nei problemi, e in generale fungono da intermediari tra gli sviluppatori del software e gli utenti di Fedora.

  • QA: L’assicurazione di qualità è il processo per assicurare che il software funzioni come previsto.

  • Bodhi: L’applicazione Web del QA di Fedora.

Prima di segnalare un bug

Passo 1: Controllare l’ultima versione

Quando sono raccolti e sistemati dei bug, gli sviluppatori preparano un insieme di aggiustamenti e periodicamente rilasciano nuove versioni del proprio software. Per cui, prima di segnalare un problema, è utile controllare di stare utilizzando l’ultima versione del software. Il modo più semplice per ottenere l’ultima versione di un software su Fedora è di aggiornare in modo regolare il proprio sistema. Utenti di Gnome/KDE e altri ambienti desktop possono utilizzare le applicazioni predefinite per farlo. Esse controllano periodicamente alla ricerca di aggiornamenti e notificano l’utente. Si può anche utilizzare il gestore dei pacchetti predefinito dnf per controllare e aggiornare il proprio sistema. Solo gli utenti con i privilegi di amministratore possono farlo:

$ sudo dnf update --refresh

Passo 2: Controllare bug già segnalati

If you are using the latest version of the software available in Fedora, then it is likely that the bug has either not been reported, or has been reported but a fix has not yet been released. So, it is useful to search the list of already reported bugs before filing a new report. The Fedora Packages Web application lists the currently reported bugs for all packages. There is also a convenient shortcut that can be used.

https://bugz.fedoraproject.org/<nome del pacchetto>

La stringa nome del pacchetto deve essere il nome formale del pacchetto.

20180825 how to file a bug gs bugs
Figure 1. L’applicazione Web di Fedora Package elenca i bug segnalati per Gnome software all’indirizzo https://bugz.fedoraproject.org/gnome-software.

As can be seen in the image, the Fedora Packages Web application also gives other information about a package.

Finding the name of the package: If you do not know the formal package name of the software, you can use the Fedora Packages Web Application to search for it and view the list of bugs there.
20180825 how to file a bug gs
Figure 2. Ricerca di Gnome software tramite l’applicazione Web di Fedora Packages.
Ricerc avanzata: Si può anche utilizzare la ricerca avanzata del tracciatore di bug per restringere una ricerca. Tuttavia non è un passo necessario.

Se un bug è stato già segnalato con la descrizione del problema, si possono aggiungere altre informazioni utili. Se non c’è nulla da aggiungere, ci si può aggiungere con "CC" (copia carbone) per ricevere eventuali aggiornamenti futuri. Questo può essere fatto cliccando il pulsante "Save changes" quando l’opzione "Add me to CC list" è selezionata come mostrato di seguito:

20180825 how to file a bug cc list
Figure 3. La lista dei CC contiene tutti gli utenti che saranno notificati quando ci saranno aggiornamenti nella segnalazione.

Segnalare un bug

Passo 0: Creare un account Bugzilla

Utilizzare il proprio account Fedora: Si può utilizzare il proprio account Fedora per autenticarsi su Bugzilla. È il metodo preferito, perché con lo stesso account si può autenticare in tutti gli altri servizi di Fedora.

I bug sono segnalati nell’istanza bugzilla di Fedora, per cui è necessario possedere un account per creare un bug o interagire con essi. Un account richiede un indirizzo email valido e può essere creato qui (cliccare su "Register"). Il tracciatore di bug invierà soltanto email di notifica sui bug che ci si è iscritti. Non verranno inviate altre email.

Passo 1: Segnalare un nuovo bug

If a bug report for the particular issue has not already been filed, you should file a new one. The easiest way to file a new report is using the "File a new bug" drop down from the right hand side bar in the Fedora Packages Web application.

20180825 how to file a bug new bug shortcut
Figure 4. L’applicazione Web di Fedora Packages fornisce una scorciatoia comoda per segnalare nuovi bug.

La scorciatoia reindirizza nel tracciatore di bug in una nuova segnalazione con un modello predefinito. L’immagine di seguito mostra il modello predefinito per un nuovo bug:

20180825 how to file a bug new bug
Figure 5. Il modello predefinito per un nuovo bug.

È necessario compilare i seguenti campi:

  • Componente: Il nome del pacchetto.

  • Versione: La versione di Fedora in cui il bug è stato osservato.

  • Sommario: Un breve sommario che descrive il problema.

  • Descrizione: Una descrizione più dettagliata che descrive il problema. Contiene già il modello predefinito, che viene spiegato di sotto.

  • Allegati: File che forniscono maggiori informazioni sul problema possono essere caricati nella segnalazione del bug utilizzando il corrispettivo pulsante. Esempi sono istantanee dello schermo, file di log, registrazioni dello schermo.

  • Gravità, Hardware, SO: Questi campi sono opzionale e possono non essere impostati.

Descrizione del problema:

Spiegare il problema in dettaglio in questo campo.

Numero di versione-rilascio dei componenti selezionati (se applicabile):

La versione del pacchetto dovrebbe essere qui specificata. Una volta che si viene a conoscenza del nome del pacchetto, la versione la si può ottenere utilizzando il comando rpm:

$ rpm -q <nome del pacchetto>

Per esempio:

$ rpm -q gnome-software
gnome-software-3.28.2-1.fc28.x86_64

Come si riproduce:

Quanto spesso viene osservato il problema? Di solito una buona risposta per questo campo è una delle seguenti:

  • Sempre: il problema viene riscontrato ogni volta.

  • Qualche volta: il problema viene riscontrato qualche volta.

  • Solo una volta: il problema è stato riscontrato una sola volta.

I problemi che occorrono sempre sono i più facili da diagnosticare per gli sviluppatori, perché sono capaci di replicarli nelle loro macchine per ottenere maggiori informazioni. Se un problema accade solo qualche volta, gli sviluppatori devono spendere più tempo ed energie per capire cosa causa il problema. Se un problema è stato osservato solamente una volta, è ancora più difficile da diagnosticare.

Segnalazioni bug dettagliati rendono più facile il bug da aggiustare: se possibile, si dovrebbe investigare sui passi necessari per far accadere il problema, scrivendoli nella sezione successiva:
Nel dubbio inviare sempre una segnalazione: Se non si è sicuri di un bug, si dovrebbe sempre inviare la segnalazione. I manutentori possono dare seguito alla segnalazione con domande per acquisire più informazioni.

Passi per riprodurre:

I passi permettono altri utenti di verificare il bug, e possono inoltre informare gli sviluppatori di specifici passi che causano il problema. Rende molto più facile controllare il codice sorgente e isolare le parti che possono essere fallate.

Risultato attuale:

Cosa viene osservato quando il problema occorre?

Risultato aspettato:

Cosa l’utente si aspettava di accadere se il software avesse funzionato correttamente?

Informazioni aggiuntive:

Qualsiasi informazione aggiuntiva che può tornare utile ai manutentori può essere aggiunta in questa parte.

Passo 2: Seguire le segnalazioni aperte

Quando un bug è stato aperto, si dovrebbe tenere un occhio per eventuali aggiornamenti. Verranno inviate notifiche email per ogni nuovo commento a chi è coinvolto nella segnalazione---il segnalatore, gli utenti e il manutentore. Spesso, i manutentori commentano con risposte a interrogazioni per collezionare maggiori informazioni sul problema. Qualche volta altri utenti che hanno lo stesso problema possono aggiungere altre informazioni.

Chiedi per istruzioni: Se il manutentore chiede maggiori informazioni ma non è chiaro come devono essere raccolte, è lecito domandare istruzioni esplicite.
Notifiche email: Le notifiche email sono inviate da zilla@redhat.com. Si dovrebbe tenere un occhio su questo indirizzo email e di aggiungerlo nella lista dei "no-spam".

Se il bug non riceve aggiornamenti in una o due settimane, si può commentare per chiedere qualsiasi informazione. Capita che il manutentore che riceve molte segnalazioni di bug posa perdere qualche notifica email. Un commento gentile permetterà di inviare una nuova notifica.

Passo 3: Provare gli aggiornamenti

Un bug ben riportato di solito viene aggiustato, e il manutentore rilascerà una nuova versione del software disponibile per gli utenti di Fedora. Bodhi aggiungerà in automatico un commento quando questo succederà. Si può aiutare il manutentore confermando se la nuova versione migliorata funziona meglio in Bodhi.

20180825 how to file a bug qa
Figure 6. L’applicazione Bodhi aggiunge commenti informando gli utenti di un aggiornamento che dovrebbe sistemare il bug.
Aiuta a provare gli aggiornamenti: Tutti gli utenti possono aiutare a provare le nuove versioni del software. Maggiori informazioni riguardo ciò si possono trovare qui. Notare che richiede un account Fedora.

Una volta che la versione migliorata del software ha superato il processo QA, il bug verrà automaticamente chiuso. Congratulazioni!