Come scrivere un messaggio Git Commit efficace e utile

I messaggi di commit sono brevi descrizioni di ogni commit in un sistema di controllo della versione come Git. Quando esegui il commit delle modifiche ai file del tuo progetto, dovresti fornire un messaggio che spieghi cosa fanno o perché le hai apportate.

I messaggi di commit servono come forma di documentazione e comunicazione. Svolgono un ruolo cruciale nel mantenere una cronologia delle versioni chiara e organizzata di un progetto. Impara a scrivere buoni messaggi di impegno e gli altri membri del tuo team apprezzeranno ancora di più il tuo lavoro.

Struttura di un buon messaggio di impegno

Un buon esempio di messaggio di commit include quattro sezioni: Tipo, Descrizione, Corpo e Piè di pagina.

Così:

: 
[corpo opzionale]
[piè di pagina facoltativo]

Tipo

Il tipo descrive il tipo di modifica apportata nel presente commit. Puoi usare qualunque sistema abbia senso per le tue circostanze. Ad esempio, ecco alcune parole chiave di esempio che puoi utilizzare per segnalare ogni tipo di modifica, insieme all'uso di esempio:

• impresa: le tue modifiche introducono una nuova funzionalità.
• aggiustare: risolvi un bug.
• refactor: modifica il tuo codice di refactoring senza correggere un bug o aggiungere una nuova funzionalità.
• test: apporti modifiche relative ai test. Ad esempio, quando tu scrivere test con Jest o qualsiasi altro framework di test Tu scegli.
• lavoretto: modifiche non correlate a correzioni, funzionalità o test. Ad esempio, l'aggiornamento delle dipendenze.
• documenti: quando aggiorni la documentazione.
• stile: modifiche che non influiscono sul significato del codice, come l'aggiunta di spazi bianchi, punti e virgola mancanti, ecc.
• perf: modifiche relative ai miglioramenti delle prestazioni.
• costruire: quando apporti modifiche che influiscono sui file di build.
• ci: modifiche relative all'integrazione continua.
• tornare indietro: quando si ripristina un commit precedente.

Descrizione

La "descrizione" di un messaggio di commit è un riepilogo conciso e descrittivo delle modifiche apportate al commit. Serve come titolo che cattura l'essenza del commit.

Quando scrivi la descrizione, tieni presente quanto segue:

• Rendilo abbastanza chiaro e specifico da descrivere il commit a colpo d'occhio.
• Sii breve e conciso. Idealmente, sarebbe meglio limitarlo a 50 caratteri o meno.
• Scrivilo al presente, anche se stai descrivendo modifiche già apportate.
• Usa lo stato d'animo imperativo mentre lo scrivi.
• Inizia con una lettera maiuscola.
• Non finirla con un punto.

Per esempio:

feat: Implementa l'attivazione della modalità oscura per la home page

Questo esempio mostra come scrivere la descrizione per un commit che implementa la modalità oscura. Utilizza il impresa type perché introduce una nuova funzionalità.

Corpo (opzionale)

La sezione del corpo di un messaggio di commit fornisce ulteriori dettagli e contesto sulle modifiche apportate al commit. Non avrai sempre bisogno di un corpo, ma può aiutarti a fornire maggiori informazioni, spiegare il ragionamento di un cambiamento o descrivere eventuali considerazioni tecniche.

Ecco alcune cose da notare durante la scrittura della sezione del corpo di un messaggio di commit:

• Git non avvolge mai il testo automaticamente, quindi avvolgilo manualmente a 72 caratteri quando scrivi il corpo. Questo dà a Git spazio sufficiente per indentare il testo, rendendolo più leggibile.
• Usa il corpo per spiegare cosa è successo nel cambiamento, perché hai apportato il cambiamento e il ragionamento alla base del tuo cambiamento.
• Devi lasciare una riga vuota tra la riga descrittiva e il corpo. Ciò consente a Git di distinguerli.
• Se il commit introduce più modifiche o influisce su aree diverse della base di codice, prendi in considerazione l'utilizzo di elenchi puntati o paragrafi per suddividere le modifiche. Ciò migliora la leggibilità e aiuta i lettori a comprendere i diversi aspetti del commit.

Per esempio:

feat: aggiungere GitHub come provider OAuth
Integra GitHub come provider OAuth per abilitare senza problemi 
autenticazione con account GitHub.
- Implementa il flusso di autenticazione OAuth con l'API GitHub
- Configurare gli endpoint e le impostazioni necessari per l'autenticazione GitHub
- Aggiorna l'interfaccia utente per includere l'opzione di accesso a GitHub

L'esempio sopra mostra un buon messaggio di commit Git per una funzionalità che aggiunge GitHub come provider OAuth alla tua candidatura. Questo messaggio di commit ha una riga di riepilogo concisa (50 caratteri o meno), un testo esplicativo più dettagliato (contornato a circa 72 caratteri) e punti elenco per ulteriori informazioni.

La sezione del piè di pagina in un messaggio di commit è una parte facoltativa che fornisce informazioni aggiuntive o metadati relativi al commit. In genere è posizionato dopo la sezione del corpo, separato da una riga vuota. Il piè di pagina può includere vari tipi di informazioni, come riferimenti a problemi correlati, tag o note speciali.

Quando si fa riferimento a problemi, richieste pull o altri elementi correlati, utilizzare la sintassi o il formato appropriato richiesto dal sistema di tracciamento dei problemi del progetto. Ciò garantisce che i riferimenti siano correttamente riconosciuti e collegati.

Per esempio:

feat: Aggiungi GitHub come provider OAuth
Integra GitHub come provider OAuth per abilitare senza problemi 
autenticazione con account GitHub.
- Implementa il flusso di autenticazione OAuth con l'API GitHub
- Configurare gli endpoint e le impostazioni necessari per l'autenticazione GitHub
- Aggiorna l'interfaccia utente per includere l'opzione di accesso a GitHub
Risolve: #123
Vedi anche: #456, #789

Il piè di pagina fa riferimento al problema correlato n. 123 e menziona altri problemi correlati n. 456 e n. 789 per un contesto aggiuntivo.

Aggiunta del messaggio di commit

Puoi scrivere messaggi di commit usando il file -M flag seguito dal messaggio di commit racchiuso tra virgolette (facoltativo ma consigliato).

IL -M flag è ideale per brevi messaggi di commit, che di solito includono il tipo e la descrizione.

Per esempio:

git commit -m "lavoro di routine: cambia linter in ESlint"

Tuttavia, quando il tuo messaggio di commit richiede più dettagli, come un corpo e un piè di pagina, faresti meglio a scrivere il commit in un editor di testo o IDE.

In alternativa, puoi scrivere lunghi messaggi di commit in un file di testo e usare il file --file flag per specificare i messaggi di commit come contenuto del file di testo.

Per esempio:

git commit --file commit_message.txt

Quando esegui il comando sopra, git utilizzerà il contenuto del file come messaggio di commit.

Puoi anche dire a git di aprire il tuo editor predefinito per scrivere un messaggio più lungo. Se hai impostato la variabile d'ambiente GIT_EDITOR o EDITOR, git aprirà quel programma quando esegui un bare git commit comando.

Perché dovresti scrivere buoni messaggi di impegno

Scrivere buoni messaggi di commit è fondamentale per una collaborazione efficace e per la manutenzione del codice. Messaggi chiari e descrittivi aiutano la comprensione, il debug e le revisioni del codice. Possono persino contribuire alla documentazione del progetto o alle note di rilascio.

Consentono la condivisione delle conoscenze, l'onboarding agevole e supportano il controllo della versione. L'assegnazione di priorità ai messaggi di commit di qualità migliora i processi di sviluppo e garantisce la manutenibilità della base di codice.