È importante avere uno stile di messaggio di commit coerente in una squadra?

Question

È importante avere uno stile di messaggio di commit coerente in una squadra?

#1 da (15 voti)
#2 da (2 voti)

4

Nel mio team di 5 codificatori, abbiamo tradizionalmente rispettato un comune standard di messaggio di commit git che indicava (solo) due regole: i messaggi di commit dovrebbero includere perché anziché solo il cosa e dovrebbero essere scritto nel passato .

Questo è abbastanza sciolto (ad esempio, alcune persone preferiscono scrivere messaggi più lunghi, altri scrivono più brevi, altri aggiungono un periodo finale, altri no), e va bene - non penso che quel tipo di eterogeneità abbia causato alcun danno finora. I nostri casi d'uso principali per i messaggi di commit - le revisioni del codice e la ricerca dei motivi per determinati cambiamenti o costrutti di codice - funzionano bene.

Recentemente, uno dei membri del team ha espresso il desiderio di seguire lo stile del repository Git, che sta diventando una best practice e impone di scrivere messaggi di commit in umore presente, imperativo , contraddicendo così le nostre regole . Il resto del team desidera continuare a utilizzare lo stile del passato, poiché lo stile imperativo sembra innaturale per loro.

Come il team ha guidato, ora mi chiedo, fino a che punto arriva la necessità di coerenza nei messaggi di commit? È importante che tutti i membri del team usano lo stesso tempo e lo stesso umore? Quali sono gli argomenti contro il permettere ad alcuni di usare uno stile, l'altro?

git coding-style version-control coding-standards

posta Fabian Schmied 28.08.2016 - 20:45

fonte

2 risposte

2

A volte le persone apprendono quali sono gli standard comunemente concordati (convenzioni) che utilizzano un determinato strumento in seguito. È ancora meglio seguire queste convenzioni e adattare presto lo stile. E tutti dovrebbero seguire una volta scoperto un fatto ben noto, perché è fastidioso procedere attraverso una lista di commit e perdere tempo, a causa di frasi strane. Poi, ci sono anche strumenti che interagiscono meglio.

Ad esempio, quando si utilizza lo stile imperativo la riga del titolo che di solito è limitata per adattarsi all'oggetto dell'email (circa 50 caratteri più tag di progetto generati automaticamente) diventa molto più breve e contiene solo le caratteristiche grammaticali necessarie (più contenuto, meno rumore ). Ha senso se si usano le e-mail come notifiche e si affidano a soggetti di facile lettura nelle visualizzazioni elenco.

risposta data 30.08.2016 - 23:13

fonte

Leggi altre domande sui tag git coding-style version-control coding-standards

Classe C ++ con solo funzioni virtuali pure: come si chiama? Confusione di classe astratta

score 15 · Accepted Answer

Gli oggetti grammaticali come il tempo verbale o l'umore non sono solitamente importanti oltre a ciò il messaggio dovrebbe avere senso ed essere comprensibile dal team. Fare un sacco di regole su come esprimere la parte in forma libera di un messaggio di commit è probabilmente un segnale sul quale si concentrano le cose sbagliate.

Più importante sarebbe la coerenza in specifici elementi sintattici. Ad esempio, se disponi di un sistema di emissione dei biglietti, se tutti i commit relativi a un ticket hanno il numero del biglietto nello stesso posto utilizzando lo stesso formato.