Git Workflow¶
Esta seção reúne os padrões Arkorizon para uso de Git em projetos de software e documentação.
Os documentos são separados para facilitar consulta rápida: commit semântico não explica groupId, release não explica branch naming, e Pull Request não substitui validação de CI.
Documentos¶
| Documento | Propósito |
|---|---|
| Commit Semântico | Define types, scopes locais, corpo, rodapé, breaking changes e exemplos de commits. |
| Branch Naming | Define prefixos, padrões de branch, branches protegidas, hotfix e release branches. |
| Pull Request Standards | Define título, descrição, revisão, validação, merge e responsabilidades. |
| Release e Versionamento | Define SemVer, tags, changelog, release notes, hotfixes e artefatos versionados. |
| Organization Rulesets | Registra as rulesets globais aplicadas na organização Arkorizon. |
Responsabilidades separadas¶
| Tema | Onde documentar |
|---|---|
| Mensagem de commit | Commit Semântico |
| Nome de branch | Branch Naming |
| Revisão e merge | Pull Request Standards |
| Tags e SemVer | Release e Versionamento |
| Regras globais da organização | Organization Rulesets |
groupId, artifactId, Docker image e repo name |
Naming Conventions |
Regra de leitura¶
Se a dúvida for sobre como nomear um projeto ou artefato, leia Naming Conventions.
Se a dúvida for sobre como registrar uma mudança no Git, leia os documentos desta seção.