Criando mensagens de commit
Índice
- Padrão das mensagens de commit
- Informe o número do ticket relacionado
- Dê os devidos créditos
- Dê detalhes
- Créditos
Uma boa mensagem de commit no repositório ajuda outros desenvolvedores a saber quais foram os motivos do commit, quem o fez (créditos do trabalho) e qual o ticket que foi fechado. Estas mensagens podem ser exportadas para um changelog (definição Wikipedia em inglês e em português).
Observação: as mensagens de commit deverão seguir este padrão. Até a revisão r16, não existia esta padronização.
Padrão das mensagens de commit
Uma mensagem de commit deve seguir o seguinte padrão:
#[NUMERO-TICKET] by [LISTA-DE-NOMES-SEPARADOS-POR-VIRGULA]: [BREVE DESCRICAO DA MUDANCA]
Informe o número do ticket relacionado
Quando um commit estiver relacionado com um ticket aberto em nosso sistema de tickets, informe o número dele. Assim, ao navegar na timeline ou no registro de revisões, o desenvolvedor ou visitante consegue ir ao ticket de origem rapidamente e ter um entendimento completo da alteração.
#11 by Eriksen: Corrigido bug que não gravava a hora em que ocorreu uma ocorrência de aluno
Se o commit não for relacionado com nenhum ticket, omita esta parte:
by Eriksen: Tagging release 1.0.0
Observação: todo ticket que já foi fechado aparece riscado na interface do Trac, dando auxílio visual.
Dê os devidos créditos
Identifique sempre a autoria do commit. Mesmo que o autor do commit seja apenas você (que já é identificado pelo seu e-mail no log do SVN), informe seu nome. Caso seu nome seja único na comunidade, o sobrenome torna-se opcional. Se não for o caso, informe seu sobrenome também. Sempre use os mesmos nomes do cadastro da comunidade i-Educar no Portal do Software Público . Escolha a forma de se identificar e use sempre a mesma a partir de então.
#7 by Eriksen Costa: Corrigido bug de SQL da ação de suspender cliente de biblioteca
Caso você tenha aplicado um patch que fora anexado em um ticket, informe o nome do contribuidor (exemplo hipotético):
#13 by Eriksen Costa, Pedro Simões: Corrigido bug durante o login que dava erro de SQL quando mais de um IP era fornecido pelo cliente
Se você não teve nenhum trabalho para aplicar o patch, como adequação do código aos padrões de codificação ou correção de algum erro do patch, não inclua o seu nome nos créditos, afinal de contas, você apenas o aplicou:
#13 by Pedro Simões: Corrigido bug durante o login que dava erro de SQL quando mais de um IP era fornecido pelo cliente
Dê detalhes
Ao fazer um commit, dê detalhes do que foi alterado. Crie uma breve descrição, iniciando com uma ação no passado:
- Adicionado (nova funcionalidade)
- Corrigido (bug)
- Alterado (refactoring)
- Atualizado (tarefa de projeto)
- Tagged (tagging de release)
Tente ser descritivo:
#7 by Eriksen Costa: Corrigido bug de SQL da ação de suspender cliente de biblioteca
Evite descrições como:
#7 by Eriksen Costa: corrigido bug
#7 by Eriksen Costa: ticket fechado
Créditos
Este documento foi baseado no Commit messages - providing history and credit do projeto Drupal.
