Con lo scorso articolo dedicato a Git abbiamo iniziato una mini serie dedicata alle best practice con Git. Questa volta aggiungiamo alla lista tre consigli o best practice per lavorare meglio con questo potentissimo strumento.
Fai commit più spesso con Git
Creare commit più piccoli, cioè contenenti meno modifiche porta una serie di vantaggi.
Se ad esempio la tua branch crea un bug o rompe l’applicazione in qualche modo sarà più semplice tornare indietro nella history e identificare il problema.
Inoltre puoi creare revert commit più specifici, senza dover creare un nuovo commit per annullare una modifica specifica.
Ultimo punto, ma non meno importante, eseguire commit più piccoli aiuta sensibilmente chi dovrà revisionare il codice: facendo la code review “commit by commit” sarà più semplice capire come le modifiche sono state aggiunte e per quale motivo.
Descrivi correttamente i tuoi commit
Un altro punto molto importante è avere un messaggio descrittivo del commit pertinente e informativo. “Bug fix” o “Refactoring” non è informativo. La cosa ottimale sarebbe avere un’intestazione per il tuo commit che indichi cosa e un corpo che indichi perché le modifiche sono state apportate. Un buon messaggio di commit è simile al seguente:
Fix: email validation shouldn’t allow trailing points
Email validation logic was accepting trailing points in email addresses. Updated regular expression to not accept trailing points
La prima riga è l’intestazione. Di solito, è l’unica cosa mostrata quando viene stampato un elenco di commit. E non dovrebbe essere più lungo di 72 caratteri, altrimenti GitHub (o GitLab) lo troncherà quando lo mostrerà.
Il corpo del commit è separato dall’intestazione da una riga vuota e contiene i motivi per cui è stata apportata questa modifica.
Crea e utilizza le branch
È molto comodo fare push su master, lo abbiamo fatto tutti. Ma di solito è buona pratica mantenere la master branch sempre pulita e funzionante. Crea una branch, aggiungi il tuo codice, rivedilo, testalo, assicurati che funzioni e poi finalmente puoi fare merge sulla master branch.
Ancora meglio, preferibilmente, crea CI jobs che controllano il tuo codice per errori di sintassi, eseguono i test, controllano la formattazione e magari anche i tuoi messaggi di commit. Per fare questo puoi usare le GitHub Actions o GitLab-CI.
Conclusione
Git è uno strumento molto potente che permette di organizzare il proprio lavoro in modo eccellente se utilizzato correttamente. In questo post abbiamo voluto elencare altri tre semplici consigli, ma ne verrano altri nei prossimi post. Stay tuned!
