Best practice per i messaggi di commit Git per moduli specifici

Question

Best practice per i messaggi di commit Git per moduli specifici

#1 da (5 voti)
#2 da (0 voti)
#3 da (0 voti)

5

Il nostro progetto attuale è composto da più moduli in /modules/ . Quando lavoro sul mio attuale modulo e aggiorno il README come dovrei scrivere un messaggio di commit per questo?

Update README
Update README in module_XYZ
Update README [module_XYZ]
module_XYZ | Update README
Qualcos'altro?

Penso che 1. abbia troppe informazioni in quanto i singoli moduli sono tutti strutturati in modo simile, quindi sarebbe ambiguo. 2 - 4 sembrano essere migliori ma questo significa che dovrei sempre aggiungere il modulename al messaggio di commit che è in qualche modo ridondante, poiché il commit effettivo mostra quale modulo (file) è interessato.

Ho letto questo bel messaggio Come scrivere un messaggio Git Commit ma non menziona come per scrivere su quale modulo influisce il commit.

git workflows

posta Tak3r07 20.10.2016 - 08:56

fonte

3 risposte

Leggi altre domande sui tag git workflows

Come evitare l'inizializzazione in due passi (C ++)? A quale livello PBI dovrei creare rami?

score 5 · Answer 1

Quando digiti git commit e il tuo editor appare, avrà un sacco di righe commentate come:

# modified: foo/bar/baz.py
# modified: foo/bar/quix.py

Sono arrivato a preferire semplicemente decommentare queste righe e aggiungere note su ciò che è stato cambiato (io tendo a preferire messaggi di commit molto prolissi, principalmente per facilitare la revisione del codice). Quindi finisco con il messaggio di commit che assomiglia a questo:

[ISSUE-XXXX] Refactored SomeClass to conform to internal team stile guide

modified: foo/bar/baz.py
- split bigMethod of SomeClass into smallMethod and tinyMethod
- added docstring to undocumentedMethod
- removed extra whitespace

score 0 · Answer 2

Generalmente uso lo stesso messaggio di commit per una determinata attività, in modo che in seguito possa trovare il nome dei file che vengono utilizzati per quell'attività usando un comando git.

Ad es. il mio compito è "# Task1"

per quanto riguarda questa attività io uso il messaggio "# Task1" per ogni commit.

Ma non devi aggiungere altri file che non sono interessati da questo "# Task1".

score 0 · Answer 3

Ho iniziato ad aggiungere il nome del modulo come prefisso seguito da due punti. Questo è il motivo:

Il modulo indica il "contesto" del messaggio, quindi ha senso metterlo davanti al messaggio.
Dal momento che sto usando l'alias "hist" comune, la sintassi "[..]" è già presente all'autore.
L'uso di due punti è un bel separatore visivo e si allinea anche con la "pratica comune di email" per separare un prefisso con due punti (ad esempio "Fwd: .."). È anche normale iniziare con una parola maiuscola dopo i due punti, quindi le best practice sono ancora rispettate.

Il risultato:

* abc1234 2018-10-02 | my-module: Update readme [rudi]
* 1234560 2018-10-01 | other-module: Update readme [rudi]
* 123b123 2018-10-01 | Apply new formating rules [rudi]