Boas práticas
Equipes sem revisão de código
Se as alterações chegam à main sem que ninguém as leia, porque agentes fazem commit direto na main ou os pull requests são mesclados assim que o CI passa, deixe o HeyDeer ser a revisão. Assim, um pull request é mesclado sozinho quando o HeyDeer o aprova.
O risco
O CI só detecta o que seus testes cobrem. Sem revisão, dois tipos de problema passam despercebidos:
- Viés do modelo. O modelo que escreveu o código tende a aceitar o próprio raciocínio e a deixar passar os próprios erros, mesmo quando você pede que ele confira o trabalho.
- Erros de edições repetidas. Quando um agente modifica o mesmo código repetidamente, cada alteração pode quebrar silenciosamente algo que uma anterior tinha acertado.
O que o HeyDeer acrescenta
- Uma opinião independente. O HeyDeer revisa cada pull request separadamente do agente que o escreveu e confere cada problema encontrado no código antes de publicá-lo.
- Um processo de revisão dedicado. Cada push recebe uma revisão, as revisões de acompanhamento verificam novamente as preocupações anteriores e a verificação HeyDeer Review registra o resultado em cada commit.
Configuração recomendada
Um agente abre um pull request
O HeyDeer revisa cada push
A verificação passa e o HeyDeer aprova
O GitHub faz o merge do pull request
Se o HeyDeer encontrar problemas, a verificação falha e nada é mesclado. O agente faz push de uma correção, e o HeyDeer revisa os novos commits.
- Abra um pull request para cada alteração. Faça os agentes enviarem as alterações para uma branch e abrirem um pull request em vez de fazer commit na main.
- Revise cada push. Em Configurações do espaço de trabalho → Regras de revisão, defina Frequência de revisão como A cada push. Consulte Revisões automáticas.
- Faça a verificação falhar quando houver problemas. Em Publicar resultados, ative Reprovar a verificação quando forem encontrados problemas. Consulte A verificação HeyDeer Review.
- Ative a aprovação automática. Em Publicar resultados, ative Aprovação automática. O HeyDeer aprova um pull request quando uma revisão completa não deixa nenhum problema. Alterações importantes de arquitetura e comportamento essencial continuam aguardando uma pessoa; para aprová-las também, defina Alterações que exigem aprovação humana como Sem restrição adicional. Consulte Aprovação automática.
- Proteja a main no GitHub. Nas regras da branch main, ative Require a pull request before merging com 1 aprovação obrigatória e Dismiss stale pull request approvals when new commits are pushed. Depois, ative Require status checks to pass before merging e adicione HeyDeer Review junto às suas verificações de CI.
- Faça o merge automaticamente. Ative Allow auto-merge nas configurações do repositório no GitHub. Depois, ative o auto-merge em cada pull request ou faça o agente executar
gh pr merge --auto --squashdepois de abrir um.
HeyDeer aprovou estas alterações
Todas as verificações foram aprovadas
HeyDeer Review — Revisão concluída — nenhum problema encontradoObrigatória
CI / test — Bem-sucedidaObrigatória
O auto-merge está ativado: o GitHub fará o merge deste pull request assim que todos os requisitos forem atendidos.
Escrever seus padrões como verificações
Os agentes seguem uma regra com mais consistência quando a revisão a exige. Adicione um arquivo Markdown em .agents/checks/ para cada regra, e o HeyDeer a aplica a todo pull request que altera arquivos correspondentes. Consulte Verificações do repositório.
.agents/checks/tenant-scope.md
---
files:
- "src/db/**/*.ts"
- "!**/*.test.ts"
---
Every query that reads or writes customer data must be
scoped to one tenant, taken from the request context and
never from request parameters.