AEX Engineering
Tools

GitHub

GitHub é a fonte oficial do código e da documentação técnica da AEX. Todo projeto vive aqui.

1 min de leitura

GitHub é a fonte oficial do código e da documentação técnica da AEX. Todo projeto vive aqui.

O padrão normativo (estrutura, branches, commits, deploy) está nos standards/. Aqui fica o como operar no dia a dia.


Papel na AEX

  • Hospedar o código de cada produto (um repositório por projeto).
  • Guardar a documentação técnica versionada junto ao código.
  • Automatizar build, testes e deploy via GitHub Actions (.github/).

Padrões que se aplicam


Fluxo no dia a dia

  1. Crie a branch a partir de develop no padrão (feature/..., fix/...).
  2. Faça commits no padrão Conventional Commits.
  3. Abra o Pull Request com descrição clara e documentação atualizada.
  4. Passe pelo checklist de code review; ao menos um revisor aprova.
  5. Merge dispara o pipeline em .github/workflows/ → deploy automático.

Boas práticas

  • Pull Requests pequenos e focados — mais fáceis de revisar.
  • Branch atualizada com a base antes de pedir review (sem conflitos).
  • .github/ guarda workflows de CI/CD e templates de issue/PR.
  • Nunca commite segredos; use .env.example e o cofre do ambiente.

Evite

  • Push direto em main — todo código entra por Pull Request.
  • PR sem documentação atualizada — não é mesclado.
  • Repositórios sem os documentos obrigatórios (ver DOCUMENTATION_STANDARD).

On this page