Versionamento
Mensagens de Versionamento
Ao realizar qualquer alteração que seja necessário realizar um commit, é importantíssimo adicionar uma mensagem que possa informar do que se trata aquela alteração. Essa mensagem deve ser breve e descritiva, explicando em poucas palavras o que foi alterado, de forma que, caso outro desenvolvedor necessite realizar uma busca pelo log de alterações, as mensagens possam servir de "filtro" para identificar o que é relevante para a sua consulta.
Deve-se evitar ao máximo realizar commits sem mensagem, principalmente em versões e no trunk.
Exemplos
Modelo de Mensagem
|
Caso XXXXX: Descrição do caso de acordo com o Mantis/Trello.
- Mensagem descritiva e em poucas palavras do que foi alterado |
Criação de branch
Ao criar um branch, deve-se informar o número do caso e a sua descrição de acordo com o Mantis/Trello:Trello.
|
Caso XXXXX: Descrição do caso de acordo com o Mantis/Trello.
- Criação do branch |
Alterações
Ao realizar o commit de alterações, além do cabeçalho indicando o número do caso e a descrição, deve-se adicionar por tópico as alterações feitas naquele commit.
|
Caso XXXXX: Descrição do caso de acordo com o Mantis/Trello.
- Alterações na lógica da rotina CalcularSaldo. - Correções no padrão de código aplicado. |
Atualização de Branch
Ao realizar a atualização de um branch, deve-se adicionar a "tag" [Atualização do Branch] no início do cabeçalho, para que ao consultar o log de alterações, o desenvolvedor identifique prontamente quais revisões são referentes à atualizações do branch e quais não são.
|
[Atualização do Branch] Caso XXXXX: Descrição do caso de acordo com o Mantis/Trello.
|