Branch Naming¶
Este documento define o padrão Arkorizon para nomes de branches Git.
Branch naming é separado de commit semântico. A branch organiza o fluxo de trabalho; o commit descreve uma mudança específica.
Formato obrigatório¶
<prefix>/<short-description>
Exemplos:
feature/add-login-flow
fix/invalid-token-expiration
docs/expand-git-workflow-standards
ci/add-pages-deploy
release/1.4.0
hotfix/token-expiration-validation
Prefixos oficiais¶
| Prefixo | Quando usar |
|---|---|
feature/ |
Nova funcionalidade. |
fix/ |
Correção de bug. |
bugfix/ |
Correção de bug quando o time preferir distinguir de fix. |
hotfix/ |
Correção urgente em produção. |
hotfit/ |
Alias permitido para compatibilidade, mas prefira hotfix. |
release/ |
Preparação de versão. |
docs/ |
Documentação. |
chore/ |
Manutenção. |
refactor/ |
Refatoração. |
ci/ |
Pipeline e automação. |
test/ |
Testes. |
perf/ |
Performance. |
build/ |
Build e empacotamento. |
security/ |
Segurança. |
experiment/ |
Experimentos temporários. |
revert/ |
Reversões. |
dependabot/ |
Automação de dependências. |
renovate/ |
Automação de dependências. |
Regras de escrita¶
- Use inglês.
- Use letras minúsculas.
- Use hífen para separar palavras.
- Não use espaços.
- Não use acentos.
- Não use nome de pessoa.
- Não use descrição genérica como
changes,updatesoufixes.
Bom:
feature/add-refresh-token-rotation
Ruim:
feature/Noah-ajustes-gerais
Branches principais¶
| Branch | Uso | Regra |
|---|---|---|
main |
Linha principal estável e deployável. | Protegida. Merge somente via PR. |
release/x.y.z |
Estabilização de versão, quando necessário. | Recebe apenas correções e ajustes de release. |
develop não é obrigatório na Arkorizon. Use apenas se houver uma necessidade real de integração contínua antes da main.
Branch de feature¶
Use para nova funcionalidade.
feature/add-project-search
feature/create-agent-template
Origem recomendada:
main
Branch de fix¶
Use para correção comum.
fix/email-normalization
fix/login-error-message
Branch de hotfix¶
Use para correção urgente em produção.
hotfix/token-expiration-validation
Este documento define apenas o nome da branch. O impacto de hotfix em versão fica em Release e Versionamento.
Branch de release¶
Use quando uma versão precisa de estabilização antes de ir para produção.
release/1.4.0
release/2.0.0
Este documento define apenas o nome da branch. Regras de versionamento, tags e release notes ficam em Release e Versionamento.
Regex de validação¶
A regra de branch naming usada nos repositórios Arkorizon segue este padrão:
^(feature|fix|bugfix|hotfix|hotfit|release|docs|chore|refactor|ci|test|perf|build|security|experiment|revert|dependabot|renovate)/[a-z0-9][a-z0-9._-]*$
Regra final¶
Uma branch deve indicar a intenção do trabalho antes mesmo de alguém abrir o PR.
Se o nome da branch não explica o propósito, ele deve ser refeito.