| ... | ... | @@ -88,15 +88,27 @@ Exemplo de commit válido: |
|
|
|
|
|
|
|
### Nomeação de branches
|
|
|
|
|
|
|
|
O projeto recomenda o uso de padrão de nomeação de branch fornecido pela ferremanta Linear. De acordo com a escrita adotada para as tasks, que inclui:
|
|
|
|
- Nome do desenvolvedor responsável
|
|
|
|
- Id da task
|
|
|
|
- Descrição da tarefa
|
|
|
|
|
|
|
|
Também pode-se incluir o número da user story correspondente para a funcionalidade.
|
|
|
|
Sendo assim um exemplo de nome de branch de acordo com o padrão especificado seria:
|
|
|
|
|
|
|
|
`nomedesenvolvedor/ai-45-us05-date-modal`
|
|
|
|
Cada nova funcionalidade, correção ou tarefa deve ser desenvolvida em uma branch própria, criada a partir da versão mais atual da branch developer.
|
|
|
|
Para manter a organização e o rastreamento claros, o nome da branch deve possuir as seguintes informações:
|
|
|
|
|
|
|
|
- **tipo:** indica a categoria da
|
|
|
|
- feat: novas funcionalidades
|
|
|
|
- fix: correção de bugs
|
|
|
|
- chore: tarefas de manutenção ou configurações que não impactam diretamente o código-fonte
|
|
|
|
- docs: alteração na documentação
|
|
|
|
- **US<id>:** identificador da User Story (ou tarefa) no sistema de gerenciamento
|
|
|
|
- nome-descritivo: breve descrição em inglês do objetivo da branch, utilizando palavras minúsculas separadas por hífens
|
|
|
|
|
|
|
|
Sendo assim um o modelo de padrão a ser seguindo seria:
|
|
|
|
|
|
|
|
`tipo/US<id>-nome-descritivo`
|
|
|
|
|
|
|
|
E exemplos de nomes de branch válidos seriam:
|
|
|
|
|
|
|
|
* `feat/US101-auth-module`
|
|
|
|
* `fix/US125-producer-validation-error`
|
|
|
|
* `chore/US130-update-dockerfile`
|
|
|
|
* `docs/US132-update-readme-contribution-guide`
|
|
|
|
|
|
|
|
## 🔍 Revisão de código
|
|
|
|
Todo código desenvolvido deve ser submetido a code review. Para que o merge request seja aprovado, ele precisa passar por uma análise, garantindo qualidade, consistência e conformidade com as diretrizes do projeto.
|
| ... | ... | |
