Um Commit Ruim pode Destruir Seu Final de Semana.

Um Commit Ruim pode Destruir Seu Final de Semana.

Seguindo com as postagem sobre temas importantes que precisam de atenção em uma equipe de desenvolvimento de software, temos agora a importância do cuidado com seu Commit.

Não é drama dizer que um commit pode acabar com seu fim de semana e de tabela, com o da sua equipe. O commit é um "ponto de salvamento" no código, e subir algo quebrando, confuso ou sem identificação vai custa horas do seu dia.

1. 1 Commit = 1 Alteração Lógica (Coerência).

• Não é um commit por arquivo.

• Não é um commit com 20 coisas diferentes.

• Cada commit resolve uma coisa.

2. Subject/ Titulo do commit.

• Ponto importante do seu commit.

• Algo curto que de o entendimento do que foi feito.

• Seja direto e escreva no imperativo ex "Correção bug de autenticação"

3. Body.

• Principal lugar de explicar O PORQUÊ da mudança e o O QUE foi alterado.

• Qualquer informação a mais sobre a origem e o desenrolar desse commit pode evitar correria de ir atrás de informações perdidas.

4. Conexão do Commit à Task/Issue.

• O controle é muito mais eficiente quando o commit está ligado à demanda a sua demanda.

• Referenciar o ID no corpo da mensagem (Ex: [#1234] ou Issue #1234). Quem lê o histórico sabe exatamente a qual demanda a alteração pertence.

5. Prefixos - padronize os commits.

• Feat: (Nova funcionalidade)

• Fix: (Correção de bug)

• Refactor: (Refatoração)

• Docs: (Mudança na documentação)

Concluindo com a estrutura dessa forma:

• Título: "Prefixo": Ação curta e imperativa

• Corpo: O Problema e A Solução

• Rodapé: Link da Issue/Task (Ex: Relacionado à issue #400)

É isso, vlw, flw.