Implementar um log de alterações
O conceito de log de alterações é bastante simples: trata-se de um arquivo que tem uma lista de alterações feitas em um projeto, geralmente na ordem das datas. O detalhamento típico é separar uma lista de versões e, em cada versão, mostrar:
- Recursos adicionados
- Recursos modificados/aprimorados
- Recursos excluídos
Algumas equipes postam os logs de alterações como postagens no blog, outras criam um arquivo CHANGELOG.md em um repositório do GitHub.
Ferramentas automatizadas de log de alterações
Embora os logs de alterações possam ser criados e mantidos manualmente, talvez você queira considerar o uso de uma ferramenta de criação automatizada de logs de alterações. Pelo menos como ponto de partida.
Usando comandos do GitHub nativos
O comando git log pode ser útil para criar conteúdo automaticamente. Por exemplo, para criar uma seção a cada versão:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Log de alterações do Git
Uma ferramenta padrão é o gitchangelog. Essa ferramenta se baseia em Python.
Gerador de log de alterações do GitHub
Outra ferramenta padrão se chama github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Essa ferramenta se baseia no Gem.
Você deve usar dados baseados em logs gerados automaticamente?
A preferência é sempre evitar despejar entradas de log em um log de alterações. Os logs são "ruidosos", portanto, é fácil criar uma bagunça que não ajuda.