Como fazer bons commits?

Redação Helena Oliveira
Edição Vinicius de Lavor
Ilustração Letícia Dutra

Artigo disponível na Sandbox 3

Afinal… por que escrever boas mensagens de commit?
Escrever mensagens de commit específicas e detalhadas é uma boa prática essencial no mundo do desenvolvimento, e permite que você tenha controle do projeto e de suas versões. Além disso, também possibilitam que o trabalho em equipe e a contribuição open source seja mais fácil. Commits funcionam como um diário, registrando todos os acontecimentos (bons e ruins) do projeto: adição de funcionalidades, bugs, documentações e soluções de problemas. Ao fazer um commit, é necessário ter em mente três objetivos:

• Por que essa mudança que você vai enviar é necessária?
• Como essa mudança resolve o problema?
• Quais os efeitos essas mudanças tem no software como um todo?

Tipos de commits Existem 14 tipos de commits, utilizados no início do cabeçalho, para identificar mais facilmente do que se trata a mudança. São eles: build: alterações que afetam o build ou dependências externas static: mudanças em conteúdos estáticos, como imagens, arquivos json, etc. ci: alterações em arquivos CI do projeto cd: alterações em arquivos CD do projeto chore: manutenções regulares de código docs: mudanças na documentação feat: adição de uma nova feature fix: correção de bug perf: mudança no código para melhorar o desempenho refactor: refatoração de código improve: mudança no código que oferece melhoria style: alteração somente em arquivos de estilo test: adição ou correção de testes revert: reverter para um commit feito anteriormente.

Mão na massa: como fazer uma boa mensagem

Cabeçalho

Explicite o tipo do commit e escreva de forma sucinta o que foi alterado, em linguagem imperativa, ou seja, no presente. Depois de escrever o cabeçalho, deixe uma linha em branco, e depois escreva o corpo da mensagem.

Corpo

Aqui você escreve mais detalhadamente qual foi a alteração realizada, o porquê de ter sido realizada e qual problema ela resolve. Nesse último ponto, é comum enumerar bugs ou issues, a fim de identificar mais facilmente qual problema foi resolvido. No fim do seu commit, se for necessário, sempre identifique a issue com #numero. Não esqueça de manter a linguagem imperativa e dividir o conteúdo em parágrafos, se possível. Também é indicado deixar uma linha em branco após cada parágrafo, para melhorar a legibilidade. Alguns times criam convenções para mensagens de commit, como não utilizar ponto final nas frases, não utilizar letras maiúsculas, etc. Busque sempre seguir as convenções estabelecidas pela sua equipe.

Dica: caso o corpo da sua mensagem possua mais que uma linha, quebre as linhas em até 74 caracteres. Assim, ao usar o comando git log, a mensagem aparecerá de forma mais agradável e identada.

docs: adiciona seção de tutorial na documentação

Adiciona a seção ‘How to use’ na documentação, como tutorial de uso do aplicativo Conta com imagens explicativas e instruções de uso

fix: corrige o retorno da função allValidFields Corrige o bug da função allValidFields retornar nil Foi adicionado um guard let na função

Resolve: #72