Aggiunte relative all'infrastruttura nei commenti di commit

2

Per rispondere a questa domanda, concordiamo su questa definizione di "messaggio di buona comunicazione" da qui :

Your comment should be brief and to the point, describing what was changed and possibly why.

e accetta che fare riferimento a un bug / problema in un messaggio di commit sia una buona cosa.

Ora, ci sono molti strumenti che si integrano con i repository VCS e, per farli funzionare, richiedono che i messaggi di commit contengano varie "informazioni di controllo" che generalmente non aggiungono valore in senso storico? Pensate,

  • Quantità di tempo impiegato per risolvere un problema ( [Spent: 4h] )
  • A / cc per notificare altri membri del team del changeset ( /cc john, jill )
  • Un tag sul server CI per distribuire il changeset su sviluppo / staging / produzione ( [deploy: production] )
  • Impostazione di un revisore ( R: jill )

Certo, tutto questo è molto conveniente per gli sviluppatori a breve termine (perché lasciare la console per premere un pulsante nell'interfaccia CI quando posso aggiungere una breve stringa al messaggio di commit), ma trovo che questi messaggi ingombrino troppo il changelog e anche troppo specifico dell'infrastruttura (cosa succede se passiamo ad un Time Tracker che usa una sintassi leggermente diversa?).

Cosa ne pensi di questi messaggi e dove traccia la linea su cosa accettare e cosa proibire?

    
posta Anton Gogolev 25.11.2013 - 11:23
fonte

2 risposte

2

Quelli non dovrebbero essere parte del messaggio di commit, dovrebbero essere allegati al commit come metadati. Vedi ad esempio note di git , che ti permettono di allegare metadati arbitrari a qualsiasi oggetto Git, inclusi blob, alberi, commit, tag annotati, tag firmati e anche note (che farebbero questo metametodato, immagino). Altri sistemi di controllo versione hanno capacità simili.

    
risposta data 25.11.2013 - 14:06
fonte
1

Se i messaggi sono abbastanza compatti e standardizzati perché alcuni strumenti possano analizzarli e agire su di essi, allora sono abbastanza compatti e standardizzati da consentire a un altro strumento o plug-in di rilevarli quando si desidera leggere il flusso puramente tecnico dello sviluppo. In altre parole, dovresti conservare i messaggi ed educare il tuo visualizzatore log VCS per filtrarli.

    
risposta data 25.11.2013 - 11:30
fonte

Leggi altre domande sui tag