Prática recomendada para mensagens git commit para módulos específicos

Question

Prática recomendada para mensagens git commit para módulos específicos

#1 resposta do (5 votos)
#2 resposta do (0 votos)
#3 resposta do (0 votos)

5

Nosso projeto atual consiste em vários módulos em /modules/ . Quando eu trabalho no meu módulo atual e, por exemplo, atualizo seu README , como devo escrever uma mensagem de confirmação para isso?

Update README
Update README in module_XYZ
Update README [module_XYZ]
module_XYZ | Update README
Algo mais?

Eu acho que 1. tem muito menos informação, já que os módulos individuais são todos estruturados de forma semelhante - portanto, isso seria ambíguo. 2 - 4 parece ser melhor, mas isso significa que eu sempre precisaria adicionar o nome do módulo à mensagem de commit que é de alguma forma redundante, já que o commit atual mostra qual módulo (arquivo) é afetado.

Li este post Como escrever uma mensagem de confirmação do Git , mas não menciona como para escrever qual módulo seu commit afeta.

git workflows

por Tak3r07 20.10.2016 / 08:56

fonte

3 respostas

Tags git workflows

REST anêmico e DDD Como você faria para criar um algoritmo de busca para um CRM?

score 5 · Answer 1

Quando você digita git commit e seu editor aparece, ele terá várias linhas comentadas como:

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

Eu comecei a preferir simplesmente descomentar essas linhas e adicionar notas sobre o que foi alterado (eu prefiro preferir mensagens de confirmação muito detalhadas, principalmente para facilitar a revisão de código). Então acabo com a mensagem de commit que se parece com isso:

[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

Eu geralmente uso a mesma mensagem de commit para uma tarefa em particular, para que depois eu possa encontrar o nome dos arquivos que são usados para aquela tarefa usando algum comando git.

Por exemplo minha tarefa é "# Task1"

sobre esta tarefa eu uso a mensagem "# Task1" para cada commit.

Mas você não deve adicionar outros arquivos que não sejam afetados por este "# Task1".

score 0 · Answer 3

Eu comecei a adicionar o nome do módulo como um prefixo seguido de dois pontos. Por isso:

O módulo declara o "contexto" da mensagem, portanto, faz sentido colocá-lo na frente da mensagem.
Como estou usando o alias "hist" comum, a sintaxe "[..]" já é apresentada ao autor.
Usar dois pontos é um bom separador visual e também se alinha à "prática comum de email" para separar um prefixo com dois pontos (por exemplo, "Fwd: .."). Também é normal começar com uma palavra maiúscula depois de dois pontos, então as melhores práticas ainda são respeitadas.

O resultado:

* 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]