Boas práticas
Como implantar na equipe
Introduza o HeyDeer em etapas e deixe que ele controle os merges apenas quando sua equipe confiar nos resultados.
Etapas
- Teste em alguns pull requests. Um novo espaço de trabalho começa com Somente manual. Comente @heydeer review em alguns pull requests recentes de tipos diferentes e compare os problemas encontrados com os dos seus revisores.
- Preencha as lacunas que você viu. Adicione apenas o que essas revisões mostraram ser necessário: convenções, regras que sempre devem valer e prioridades. Consulte Onde cada regra deve ficar.
- Ative as revisões automáticas. Comece com Uma vez por PR em um ou dois repositórios, depois passe para A cada push com um Máximo de revisões automáticas por PR e defina a frequência da organização. Consulte Revisões automáticas.
- Publique a verificação sem bloquear merges com ela. Por padrão, a verificação HeyDeer Review passa mesmo quando a revisão encontra problemas. Mantenha assim enquanto a equipe se acostuma com os problemas encontrados.
- Exija a verificação quando a equipe confiar nela. Torne HeyDeer Review uma verificação obrigatória nas regras de branch do GitHub e depois ative Reprovar a verificação quando forem encontrados problemas. A partir daí, uma versão que não for revisada automaticamente aguarda @heydeer review. Consulte A verificação HeyDeer Review.
- Decida sobre a aprovação automática. Ela vem desativada por padrão. Se ativá-la, comece com Apenas alterações simples e descarte aprovações obsoletas nas regras de branch. Consulte Aprovação automática.
- Configure notificações e controle de gastos. Adicione um e-mail do espaço de trabalho para avisos de créditos e do teste e ative a recarga automática com um limite de uso. Consulte Notificações e Recarga automática e limites de uso.
- Explique à equipe como trabalhar com o HeyDeer. Compartilhe os comandos em comentários do PR, como recusar um problema encontrado com uma resposta e como escrever pull requests fáceis de revisar.
Checklist
- Alguns pull requests reais revisados com Somente manual
- AGENTS.md, verificações ou instruções adicionados para o que essas revisões deixaram passar
- Arquivos gerados marcados e pull requests de bots filtrados
- Uma vez por PR ativado e, depois, A cada push com um limite de revisões
- Verificação HeyDeer Review publicada sem reprovar quando há problemas
- Decisão tomada sobre exigir a verificação e reprová-la quando houver problemas
- Decisão tomada sobre a aprovação automática
- E-mail de notificação, recarga automática e limite de uso definidos
- Comandos e forma de recusar um problema encontrado compartilhados com a equipe
Depois de algumas semanas, releia as revisões recentes, mova as regras que estiverem no lugar errado e remova as que não mudam nada.