Ogni issue dovrebbe avere un topic nel titolo es. [BUG], [SUGGESTION] (etc.), o eventualmente delle label.
Ogni issue dovrebbe avere un titolo significativo.
Se la issue descrive un bug dovrebbe contenere diverse informazioni:
Comportamento atteso: cosa mi sarei aspettato/a;
Comportamento inaspettato: cosa è successo che NON doveva succedere;
Replicazione del bug: per ottenere questo bug ho fatto queste cose...;
Screenshot (se possibile) per poter osservare gli effetti del bug;
(Proposte, suggerimenti, soluzioni).
Un esempio potrebbe essere:
[BUG] Caricamento scorretto di informazioni nella CLI
Comportamento atteso: la CLI avrebbe dovuto mostrare le informazioni relative a (...).
Comportamento inaspettato: la CLI ha caricato delle informazioni in modo scorretto, mostrando (...).
Replicazione del bug: 1. connessione al server; 2. creazione di una partita; 3. ingresso nella partita; 4. comando (...), ...
Un esempio potrebbe essere: