| ... | ... | @@ -12,3 +12,38 @@ _Sumário_ |
|
|
|
## Gitflow
|
|
|
|
Nos baseamos profudamente no Gitflow que é um modelo de ramificação do Git que ajuda a organizar o desenvolvimento de software de forma estruturada, especialmente em projetos com ciclos de lançamento agendados.
|
|
|
|
|
|
|
|
## Padrões de Commit
|
|
|
|
|
|
|
|
Nosso padrão de commits será baseado no **Conventional Commits**, uma convenção de mensagens de commit estruturada que facilita a comunicação e o rastreamento de alterações no código.
|
|
|
|
|
|
|
|
### Estrutura das Mensagens de Commit
|
|
|
|
|
|
|
|
Cada mensagem de commit deve ser estruturada da seguinte maneira:
|
|
|
|
|
|
|
|
- **Tipo:** Comece com um tipo (feat, fix, docs, style, refactor, test, chore).
|
|
|
|
- **ID da Task entre Parênteses:** Siga o tipo com o ID da tarefa entre parênteses, um dois-pontos e um espaço.
|
|
|
|
- **Breve Descrição:** Forneça uma breve descrição do que foi alterado, começando com uma letra maiúscula e sem ponto final.
|
|
|
|
|
|
|
|
### Limite de Caracteres
|
|
|
|
|
|
|
|
A mensagem de commit deve ter um limite de 75 caracteres para incentivar mensagens descritivas e relevantes.
|
|
|
|
|
|
|
|
### Tipos de Mensagens de Commit
|
|
|
|
|
|
|
|
O tipo deve ser escolhido com base no tipo de alteração que está sendo feita:
|
|
|
|
|
|
|
|
- **feat:** Para adicionar uma nova funcionalidade.
|
|
|
|
- **fix:** Para corrigir um bug.
|
|
|
|
- **docs:** Para alterações apenas na documentação.
|
|
|
|
- **style:** Para alterações de estilização.
|
|
|
|
- **refactor:** Para alterações de código que não adicionam uma nova funcionalidade ou corrigem um bug.
|
|
|
|
- **test:** Para adicionar ou alterar testes.
|
|
|
|
- **chore:** Para alterações em arquivos de configuração ou outras tarefas de manutenção.
|
|
|
|
|
|
|
|
### Exemplo
|
|
|
|
feat(1234): Adiciona a funcionalidade de busca por nome de usuário
|
|
|
|
No exemplo acima, o verbo "Adiciona" é utilizado para indicar que uma nova funcionalidade está sendo adicionada. Isso torna a mensagem mais clara e direta, facilitando a comunicação e o entendimento das alterações realizadas no código.
|
|
|
|
|
|
|
|
### Recursos Adicionais
|
|
|
|
|
|
|
|
Para saber mais sobre Conventional Commits, visite o site oficial dos Conventional Commits. |
|
|
\ No newline at end of file |
