Guia de Fluxo de Branches e Pull Requests

[Alan-oliveir]

Este guia documenta como funciona o fluxo de desenvolvimento com as branches main e develop, bem como as proteções configuradas no repositório.

---

1️⃣ Estrutura de Branches

• main → Branch de produção. Código estável e revisado. Possui proteções rigorosas.
• develop → Branch de integração. Código aprovado, mas ainda em desenvolvimento.
• Branches de feature → Criadas a partir de develop para implementar novas funcionalidades ou correções.

Exemplo de fluxo:

feature/nova-funcionalidade → PR para develop → revisão dupla → merge em develop → testes → merge em main

---

2️⃣ Diagrama do fluxo

gitGraph
    commit id: "Inicio"
    branch develop
    commit id: "Configuração inicial"
    branch feature/1
    commit id: "Implementar feature 1"
    commit id: "Ajustes pós-review"
    checkout develop
    merge feature/1
    branch feature/2
    commit id: "Implementar feature 2"
    checkout develop
    merge feature/2
    checkout main
    merge develop tag: "Release v1.0"

Loading

O fluxo acima mostra como as branches de feature são integradas em develop, revisadas e posteriormente unificadas em main.

---

3️⃣ Proteções da main

Regra	Status
Exclusão da branch	❌ Bloqueada
Commits diretos	❌ Bloqueados
Pull Requests obrigatórios	✅ Sim
Aprovações mínimas	✅ 2 revisores
Revisão de CODEOWNERS	✅ Obrigatória
Revisões desatualizadas são descartadas	❌ Não
Aprovação do último commit pelo autor	❌ Não
Resolução de threads de review	❌ Não obrigatória
Assinatura de commits	✅ Obrigatória
Métodos de merge permitidos	✅ Merge, Squash, Rebase

---

4️⃣ Proteções da develop

Regra	Sugestão
Exclusão da branch	❌ Bloqueada
Commits diretos	❌ Bloqueados
Pull Requests obrigatórios	✅ Sim
Aprovações mínimas	✅ 2 revisores
Revisão de CODEOWNERS	✅ Obrigatória
Assinatura de commits	Opcional
Métodos de merge permitidos	Merge, Squash, Rebase

---

5️⃣ CODEOWNERS

O arquivo CODEOWNERS garante que revisões específicas sejam solicitadas automaticamente:

# Responsável pelo diretório frontend
/frontend/   @cleytonjesus07

# Responsável pelo diretório backend
/backend/    @Bruno-Pimenta

# Responsável pelo arquivo de configuração geral
/config.yml  @Alan-oliveir

# Responsável por todo o repositório (fallback)
*           @Alan-oliveir

---

6️⃣ Fluxo de Pull Requests

1. Criar branch a partir de develop:

   git checkout develop
   git pull
   git checkout -b feature/minha-feature

2. Implementar a funcionalidade ou correção.

3. Subir as alterações:

   git add .
   git commit -m "feat: descrição da feature"
   git push origin feature/minha-feature

4. Abrir Pull Request para develop:

   • Pelo menos 2 revisores devem aprovar.
   • Revisão de CODEOWNERS é obrigatória.

5. Revisores analisam código, pedem ajustes se necessário e aprovam.

6. Após aprovação, realizar merge em develop.

7. Quando develop estiver estável, criar PR para main seguindo as mesmas regras.

---

✅ Resultado esperado:

• main: sempre estável, pronta para deploy.
• develop: branch de integração com código aprovado e em evolução.
• Cada PR revisado por no mínimo 2 pessoas com suporte do CODEOWNERS.