heydeer
Boas práticas

Equipes com revisores humanos

Use esta configuração quando pessoas revisam todo pull request antes do merge. O HeyDeer confere os detalhes primeiro, para que seus revisores possam se concentrar em decisões de design e de produto.

Configuração recomendada

Um pull request é aberto
O HeyDeer revisa os detalhes
O autor corrige os problemas encontrados
Um revisor avalia o design e faz o merge
  1. Em Configurações do espaço de trabalho → Regras de revisão → Quando revisar, selecione A cada push. Consulte Revisões automáticas.
  2. Em Publicar resultados, ative Reprovar a verificação quando forem encontrados problemas. Consulte A verificação HeyDeer Review.
  3. Nas regras de branch do GitHub para a main, torne obrigatória a verificação HeyDeer Review. Assim, um pull request só pode ser mesclado depois que o HeyDeer revisa o commit mais recente dele e que os problemas encontrados e as preocupações anteriores são corrigidos ou recusados.
  4. Peça aos revisores que comecem a ler um pull request depois que a verificação HeyDeer Review dele passar. Assim, eles podem se concentrar no design, no comportamento do produto e nas perguntas que o HeyDeer lista em Precisa de esclarecimento.
Algumas verificações não foram bem-sucedidas
HeyDeer Review — A revisão encontrou problemas a resolver
CI / test — Bem-sucedida
O merge está bloqueado
Com a verificação obrigatória, um pull request não pode ser mesclado até que os problemas encontrados sejam corrigidos ou recusados.

Um commit que o HeyDeer não revisa automaticamente, por exemplo, depois que o pull request atinge o Máximo de revisões automáticas por PR, também bloqueia o merge até que alguém solicite uma revisão. Consulte Solução de problemas.

Opcional: aprovar alterações rotineiras automaticamente

Ative a aprovação automática e mantenha PRs que o HeyDeer pode aprovar em PRs de risco baixo e médio. Assim o HeyDeer aprova pull requests rotineiros quando não restam problemas encontrados. Pull requests de risco alto aguardam uma pessoa, e a revisão explica o motivo.

Com 1 aprovação obrigatória nas regras de branch, pull requests rotineiros podem ser mesclados sem esperar por um revisor. Ative Dismiss stale pull request approvals when new commits are pushed para que toda aprovação cubra o código mais recente.

Escrever seus padrões como verificações

Um requisito que seus revisores vivem repetindo em comentários deve virar uma verificação. Adicione um arquivo Markdown em .agents/checks/ para cada requisito, e o HeyDeer o aplica a todo pull request que altera arquivos correspondentes. Consulte Verificações do repositório.

.agents/checks/migrations.md

---
files: "migrations/**/*.sql"
---
The previous release keeps running while a migration
deploys. Report a migration that:

- drops or renames a table or column that code on the
  base branch still uses;
- adds a NOT NULL column without a default;
- creates an index on an existing table without
  CONCURRENTLY.

O que o HeyDeer assume

  • Detalhes e casos extremos. Em todo pull request, o HeyDeer verifica o tratamento de erros, os valores-limite, a concorrência e os chamadores que uma alteração quebra.
  • Precisão nos detalhes. Em 1.000 pull requests internos, o HeyDeer avaliou se os detalhes estavam corretos com mais precisão do que revisores humanos.