Messaggio Git Commit: best practice

Messaggio Git Commit Best Practice



Nello sviluppo, comunicare con altre persone per le revisioni e la comprensione del progetto è piuttosto importante. Tuttavia, Git richiede un messaggio per il commit. È il modo migliore per specificare una varietà di dettagli sul messaggio di commit. Descrive ciò che gli utenti hanno modificato nel progetto. In particolare, è importante scrivere un buon messaggio di commit che sia di facile lettura e comprensione. Non importa se si tratta di un progetto locale o remoto.

Questo post riguarderà quanto segue:







Cos'è il messaggio Git Commit?

Un messaggio di commit Git è una breve spiegazione della modifica apportata a un repository Git in un determinato momento. È una registrazione delle modifiche apportate da uno sviluppatore, incluse le modifiche al codice, le aggiunte e le eliminazioni.



Quando gli utenti modificano il proprio codice, lo mettono in scena utilizzando il ' git add ” comando. Una volta che tutte le modifiche sono state messe in scena, devono eseguire il commit di tutte le modifiche. A tale scopo, esegui il comando 'git commit'. È richiesto un messaggio di commit per ogni commit e dovrebbe descrivere quali modifiche sono state apportate al commit.



Best practice per i messaggi Git Commit

Esistono numerose pratiche per i messaggi di commit Git. Alcuni di essi sono elencati di seguito:





  • Mantieni il messaggio di commit breve e comprensibile.
  • Il messaggio deve contenere meno di 40 caratteri e riassumere le modifiche.
  • Inizia sempre il messaggio con un verbo impressionante, come ' Aggiungi”, “Correggi”, “Aggiorna” “Elimina ” e molti altri che rendono un messaggio chiaro e conciso.
  • Gli utenti possono indicare tutti i commit in un elenco o in un punto elenco.
  • Includere una breve spiegazione del motivo per cui sono state apportate le modifiche nel corpo del messaggio di commit. Può aiutare gli altri a comprendere la logica alla base dei cambiamenti.
  • Dividi sempre l'oggetto e il corpo con una riga vuota. Questo migliora la leggibilità e aiuta a distinguere il sommario dai dettagli.
  • Utilizza la stessa formattazione e lo stesso stile per tutti i messaggi di commit in un progetto.
  • Utilizza sempre l'ortografia e la grammatica corrette.
  • Un linguaggio chiaro e corretto migliora la leggibilità e la professionalità del messaggio.

Come eseguire il commit dei messaggi in Git?

Per eseguire il commit di un messaggio in Git, segui le istruzioni fornite di seguito:

  • Reindirizza al repository desiderato.
  • Crea o aggiorna un file.
  • Tenere traccia delle modifiche all'area di staging.
  • Utilizza il comando 'git commit' con il flag '-m' per il messaggio di commit in esso contenuto.

Passaggio 1: vai alla directory Git locale

Inizialmente, avvia il terminale Git Bash sul tuo sistema e vai al repository locale desiderato utilizzando il comando ' CD comando:



CD 'C:\Utenti\utente\Git\projectrepo'

Passaggio 2: visualizza lo stato di Git

Esegui il ' stato git ” comando per controllare lo stato di funzionamento corrente:

stato git

L'immagine risultante mostra che l'area di lavoro è pulita e non c'è nulla da commettere:

Passaggio 3: Genera file

Creare un file nell'area di lavoro eseguendo il comando 'touch' insieme al nome del file:

tocco f3.txt

Passaggio 4: aggiungere file non tracciati nell'area di gestione temporanea

Utilizzare il seguente comando per tenere traccia delle modifiche dall'area di lavoro all'area di staging:

git add f3.txt

Passaggio 5: verifica il file tracciato

Successivamente, esegui il comando indicato di seguito per verificare se le modifiche sono state rilevate o meno:

stato git

Si può notare che il file è stato aggiunto correttamente all'area di staging:

Passaggio 6: conferma il messaggio

Confermare tutte le modifiche con l'aiuto del ' git commit comando:

git commit

L'output fornito di seguito indica il nome dell'editor specificato ' COMMIT_EDITNSG ” è stato aperto. Inserisci un messaggio di commit per confermare tutte le modifiche:

Dopo aver inserito il messaggio di commit, salvare le modifiche premendo il tasto ' CTRL+S ” e chiudendo l'editor. Di conseguenza, tutte le modifiche sono state eseguite correttamente:

Inoltre, puoi anche specificare il messaggio insieme al ' git commit ” comando con l'aiuto del “ -M ' bandiera. Come segue:

git commit -M 'le modifiche sono state monitorate'

L'output indicato di seguito indica che tutte le modifiche sono state salvate:

Questo è tutto sul messaggio Git commit e sulle migliori pratiche per questo.

Conclusione

Un messaggio di commit Git è una breve descrizione della modifica apportata a un repository Git in un determinato momento. È necessario tenere a mente alcuni punti importanti sulla scrittura del messaggio di commit, come mantenere il messaggio di commit breve e comprensibile. Inoltre, il messaggio deve essere inferiore a 40 caratteri e riassumere le modifiche. Questo post ha descritto tutto sul messaggio di commit Git e le sue migliori pratiche.