Messaggi di commit corretti

Question

A cosa servono i messaggi di commit? Li ho sempre scritti come spiegazione di quello che ho fatto, ma di recente sono entrato in una discussione al riguardo con un collega che scrive messaggi che spiegano perché lo ha fatto. Qual è il giusto, o c'è un'altra risposta completamente?

NOTA: Non ho assolutamente idea se esiste una risposta "giusta" per questo. Come tale, l'ho etichettato come wiki della comunità e non accetterò una risposta. Gli Upvotes decideranno il vincitore :)

Answer 1

Come preferenza personale, posso dire a che cosa è stato fatto osservando direttamente le differenze nei file. Il perché è la cosa che non posso dedurre semplicemente guardando le modifiche effettive.

Se le modifiche sono significative o complicate, quindi includerei non solo il perché, ma anche una breve panoramica dello come.

Answer 2

Penso che entrambi siano utili. Una rapida descrizione di ciò che è stato modificato ("Aggiunta della convalida della lunghezza per AddUserForm") è più semplice rispetto a una differenza, specialmente se stai sfogliando più commit. Perché il cambiamento è stato fatto, quale bug è stato corretto, ecc. È ovviamente una cosa molto buona da avere, anche.

Answer 3

Io uso il messaggio di commit come executive summary di ciò è stato cambiato.

Il sommario esecutivo è un [...] breve documento che riassume [...] in modo tale che i lettori possano rapidamente familiarizzare con una grande quantità di materiale senza dover leggere tutto.

Il perché è documentato da qualche altra parte: un sistema di tracciamento problema, i requisiti di documentazione, ecc ho comprendono anche collegamenti dal messaggio di commit al perché, e viceversa.

Answer 4

I messaggi di commit sono ciò che si fa di loro, ma quando ce ne sono centinaia per un determinato file o migliaia per un progetto, si desidera essere in grado di scansionarli cercando determinate modifiche o la natura delle modifiche . In effetti, sono come i commenti al codice e devono essere il più utile possibile, ma conciso e conciso. Forse è meglio pensarli come tweet: trasmettere il massimo significato in un breve spazio.

Come qualcuno che ha lavorato su basi di codice di grandi dimensioni per decenni, e anche su progetti più piccoli che abbracciano un anno o due, non ho trovato nulla di più irritante quando combavo registri di commit di messaggi come "oops" o "bug fisso". Se hai corretto un bug, dicci quale (un numero di bug, per lo meno). È tutto importante per l'inevitabile analisi legale in fondo alla strada.