Guida alla manutenzione del bot

[dag7dev]

Il bot è stato finalmente riscritto in una libreria che auspicabilmente non verrà deprecata.

Env file

Non appesantire l'env file, aggiungendo variabili e stringhe inutili.

Gestire il numero di versione

• x.y.z dove x è major, y minor e z è patch:
  • x non dovrebbe venire incrementato, a meno che non venga cambiata la libreria o si modificano le funzioni in modo non retrocompatibile
    • ad esempio siamo alla versione 1.0.0: il comando info produce la lista dei colori preferiti del tuo compagno di merende --> x viene incrementato di 1 --> 2.0.0
  • y viene incrementato solo se vengono aggiunte nuove funzionalità
    • ad esempio siamo alla versione 1.0.0: viene aggiunta una funzionalità per fare il caffé --> y viene incrementato di 1 --> 1.1.0
  • z viene incrementato solo se vengono fatti cambiamenti considerati minimi (es. bugfix)
    • ad esempio siamo alla versione 1.0.0: viene corretto un bug --> z viene incrementato di 1 --> 1.0.1

Come contribuire

Come fare un commit in maniera efficiente: https://www.conventionalcommits.org/en/v1.0.0/#summary

Modifiche al codice

1. Prenotarsi nella issue: scrivere nei commenti di ogni issue della quale volete occuparvi e vi verrà assegnato il task in questione.

2. Lavorare su un branch separato con un nome significativo (es. se il comando è /help un nome del branch potrebbe essere help-cmd)

3. A stato abbastanza maturo della funzionalità, aprire una PR sul branch main. Se avete bisogno di cambiare qualcosa, basta segnarla come draft.

Codestyle, commenti, codice

Siamo fan della pulizia e vorremmo non scrivere il codice sorgente, o ricevere tra dieci anni chiamate su "quel dì di maggio che implementammo x funzionalità".

TLDR;

Grazie a chi si è prodigato alla stesura del nuovo bot.

Grazie in anticipo a chi vorrà dare una mano.