heydeer Entrar
Boas práticas

Equipes com revisores humanos

Se pessoas revisam cada pull request, boa parte do tempo delas vai para detalhes e casos extremos. O HeyDeer cuida disso em todo pull request, para que seus revisores possam se concentrar em decisões de design e de produto.

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.
  • Menos carga para os revisores. Os revisores não precisam mais percorrer cada linha em busca de erros, o que preserva o tempo e a atenção deles para as decisões que só eles podem tomar.
  • Precisão nos detalhes. Em 1.000 pull requests internos, o HeyDeer avaliou a correção dos detalhes com mais precisão do que revisores humanos.

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. 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.
  2. 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.
  3. Exija a verificação no GitHub. Nas regras da branch main, ative Require status checks to pass before merging e adicione HeyDeer Review. Assim, um pull request só é mesclado depois que os problemas encontrados forem corrigidos ou recusados.
  4. Comece a revisão humana a partir do resultado do HeyDeer. Peça aos revisores que abram um pull request quando a verificação dele passar e dediquem o tempo ao design, ao comportamento do produto e a tudo o que o HeyDeer sinalizar para uma pessoa avaliar.
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.

Opcional: aprovar alterações rotineiras automaticamente

Ative a Aprovação automática e mantenha Alterações que exigem aprovação humana definida como Alterações importantes de arquitetura e comportamento essencial. Assim, o HeyDeer aprova pull requests rotineiros quando não resta nenhum problema e deixa as alterações importantes para uma pessoa, apontando a decisão que precisa dela.

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

Uma regra que seus revisores vivem repetindo em comentários deve virar uma verificação. 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/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.