Lembre-se sempre de atualizar o seu branch principal (develop) antes de criar um novo branch.
Para criar novos branches siga os 2 passos abaixo para um nome que faça sentido:
Passo 1: Definir a categoria e/ou tipo do branch:
- improv: Melhorias em um código já existente, podendo ser melhorias de estilo do código, performáticas e/ou ajustes em alguma funcionalidade existente;
- feat: Novas funcionalidades;
- fix: Correção de bugs;
- test: Exclusivamente para adicionar, modificar e/ou excluir testes;
- docs: Exclusivamente para adicionar, modificar e/ou excluir documentação.
Passo 2: Definir um resumo da alteração que o branch vai fazer no código principal, usando palavras em inglês.
Três a Quatro palavras, exemplos:
feat/create-new-opportunity
fix/validation-login-page
docs/modify-endpoint-register
Basicamente pense em responder com 1 frase a seguinte pergunta:
“O que essa(s) minha(s) alteração(ões) faz(em)?”
A mensagem do commit precisa ser em inglês e responder a pergunta anterior.
Exemplos:
"Create a new opportunity page Modify the docs from register endpoint Fix the problem with login validation form Change the rules from admin user"
-
Para cada pull request deve ter apenas 1 commit atrelado, já contendo todas as alterações necessárias para aquela implementação/modificação no código (incluindo testes e alterações na documentação)
-
Priorizar sempre fazer pequenos pull requests, ou seja, com um número de arquivos modificados pequeno, por exemplo, 10 arquivos no máximo (salvo os casos onde seja necessário alterar vários arquivos por questões de design do código).
-
Cada pull request precisará ter no mínimo 02 approves para que possa ser mesclado/aceito.
A pessoa responsável pela criação do pull request é quem deve fazer o “Merge”.