Pré-requisito:
– Conhecimento GIT Básico CLI
– git commit, git add, git status, git merge, git branch, git checkout
Então o intuito deste post é ajudar a colocar mensagem significativa nos commits na branch.
Uma outra recomendação é criar branches secundária e não escrever diretamente na branch main ou branch master- nome master está em desuso. Sugestão de nomes nas branches
hotfix/nome_solucao
bugfix/nome_solucao
feature/nome_solucao
E uma infinidades de outros nomes nas branches.
O que realmente interessa é escrever uma boa mensagem no git message commit. Então vou repassar sugestão de como deve escrever tais mensagem.
Para commit fácil escreva apenas o título, sendo uma descrição de menos 50 caracteres, no imperativo.
Vamos entender o que é imperativo?
Segundo a gramática portuguesa, as frases Imperativas: ocorrem quando o emissor da mensagem dá uma ordem, um conselho ou faz um pedido, utilizando o verbo no modo imperativo. Podem ser afirmativas ou negativas.
Por exemplo:
- Desista!
- Vá por ali.
- Siga-me!
- Não desista!
- Não vá por ali.
- Não me siga!
Para commit difícil temos que colocar título, corpo e rodapé. No corpo crie linhas de até 72 caracteres, no rodapé dizer a demanda do sistema.
Todos os commit vão necessitar de um título e para que seja significativo teremos que seguir boas práticas de documentação.
feat: sempre que sua alteração for relacionada uma nova feature;
fix: quando tiver em fix em produção;
docs: quando sua alteração for em uma documentação;
refactor: quando suas alterações são relacionadas a refatoração de código;
test: quando seu commit for de código relacionado a testes;
chore: quando for atualizar tasks of build, ou alguma outra configuração.
Exemplo prático
$ git commit -m “feat: Gerenciar alunos”
$ git commit -m “docs: Instrução de inserir professor”
Nos exemplos acimas podemos induzir em entrar em detalhes do código que primeiro trata-se de uma nova funcionalidade criada e outros trata-se de instruções apenas nos arquivos da documentação.