Skip to main content
Você pode alterar o que o Code Review sinaliza no seu repositório fazendo commit de instruções nele. É assim que você reduz o volume de nits, interrompe comentários em arquivos gerados ou adiciona uma regra com a qual sua equipe se importa. Coloque-as em um de dois arquivos:
  • CLAUDE.md: instruções do projeto que o Claude Code lê para toda tarefa, incluindo revisões. O Code Review as lê como contexto do projeto e sinaliza alterações que as violam.
  • REVIEW.md: instruções apenas para revisões. Use-o para dizer o que sua equipe quer que seja sinalizado, com qual severidade, e o que ignorar.
Adicione o REVIEW.md na raiz do seu repositório e faça o merge. Em seguida, proteja seu branch padrão.
Para alterar o quão minuciosas são as revisões ou quando elas são executadas, peça a um Owner que altere o nível de revisão ou a configuração Review runs.

Use o CLAUDE.md para regras de todo o projeto

O Code Review lê os arquivos CLAUDE.md do seu repositório como contexto do projeto. Uma alteração que viola uma de suas regras se torna uma descoberta no nível de severidade que for adequado ao problema. Uma revisão lê o CLAUDE.md na raiz do seu repositório e os arquivos CLAUDE.md nos diretórios pais de cada arquivo alterado. O CLAUDE.md de um subdiretório é lido quando o pull request altera um arquivo sob esse caminho.

Use o REVIEW.md para regras exclusivas de revisão

O REVIEW.md é um arquivo na raiz do seu repositório que adapta o Code Review ao seu repositório. Você também pode adicionar um REVIEW.md em um subdiretório para adicionar verificações para alterações sob esse caminho, além do arquivo raiz. Os agentes que encontram problemas e os agentes que os verificam recebem seu conteúdo como as instruções de revisão do seu repositório, junto com as orientações de revisão padrão do Code Review. A etapa que escreve a revisão final o consulta antes de definir a severidade e escrever o resumo. Este layout de exemplo tem um arquivo raiz e um arquivo de subdiretório:
Antes de depender de um arquivo de subdiretório, proteja seu branch padrão e verifique o que uma revisão lê para a configuração dos seus branches.
O serviço Code Review e o comando /code-review local são duas ferramentas separadas, e elas leem arquivos diferentes. O serviço lê tanto o CLAUDE.md quanto o REVIEW.md. O comando /code-review, que você executa dentro de uma sessão do Claude Code na sua própria máquina, lê seus arquivos CLAUDE.md e não o REVIEW.md. Coloque as orientações que você quer aplicadas nos dois lugares no CLAUDE.md, e reserve o REVIEW.md para regras específicas da revisão de pull requests.

Exemplo de REVIEW.md

Este REVIEW.md recalibra a severidade para um serviço de backend, limita os nits, ignora arquivos gerados e adiciona verificações específicas do repositório.

Escolha o que escrever no REVIEW.md

O REVIEW.md é Markdown de formato livre que altera o que uma revisão encontra e relata. Ele não altera o formato da revisão. Encontre o problema que você está observando e adicione uma instrução como a mostrada. O exemplo usa as quatro primeiras.
  • As coisas erradas são marcadas como Important: redefina o que 🔴 Important significa para o seu repositório. A calibração padrão tem como alvo código de produção, e um repositório de documentação, um repositório de configuração ou um protótipo pode querer uma definição muito mais restrita. Declare quais classes de descoberta são Important e quais são no máximo Nit. Você também pode escalar, por exemplo, tratando qualquer violação do CLAUDE.md como Important.
  • Nits demais: limite quantos comentários 🟡 Nit uma única revisão publica. Um limite como “relate no máximo cinco nits” mantém as revisões acionáveis.
  • Comentários em arquivos gerados ou no que o CI já verifica: liste caminhos e categorias de descoberta em que o Claude deve ignorar descobertas. Candidatos comuns são código gerado, lockfiles e dependências vendorizadas, junto com qualquer coisa que seu CI já impõe, como linting ou verificação ortográfica. Para caminhos que merecem alguma revisão, mas não um escrutínio completo, defina um padrão mais alto: “em scripts/, relate apenas se for quase certo e grave.”
  • Uma regra da equipe não está sendo verificada: adicione regras que você quer sinalizadas em todo pull request, como “novas rotas de API devem ter um teste de integração.”
  • Descobertas que acabam se revelando erradas: exija evidências antes que uma classe de descoberta seja publicada. Por exemplo, “afirmações sobre comportamento precisam de uma citação file:line no código-fonte, não de uma inferência a partir de nomes” reduz falsos positivos que, de outra forma, custariam ao autor uma ida e volta.
Algumas dessas instruções precisam do arquivo raiz em um branch padrão protegido. Mantenha no REVIEW.md apenas instruções que alteram o comportamento da revisão, e deixe o contexto geral do projeto no CLAUDE.md.

De qual branch o REVIEW.md é lido

O Code Review lê o REVIEW.md do branch base do pull request ou do branch padrão, nunca das próprias alterações do pull request. Para alterar o comportamento da revisão, faça primeiro o merge da alteração no REVIEW.md. Mantenha o REVIEW.md no seu branch padrão e proteja esse branch. Quando uma revisão lê a cópia em um branch padrão protegido, a primeira linha da tabela abaixo, ela respeita estas instruções do arquivo raiz:
  • Reduzir a severidade de uma descoberta
  • Excluir caminhos, arquivos ou classes de problema
  • Limitar comentários de nit

O que conta como proteção de branch

O Code Review considera estas configurações como proteção:
  • Branch padrão: uma regra clássica de proteção de branch ou um ruleset
  • Qualquer outro branch: apenas um ruleset
Um ruleset conta quando restringe atualizações ou exige pull requests com pelo menos uma aprovação. Se ele exigir pull requests, também deve descartar essa aprovação em um novo push ou exigir que a aprovação venha após o último push.

O que uma revisão lê para cada configuração de branch

Encontre a situação do seu repositório na primeira coluna da tabela abaixo. Se a check run mencionar o REVIEW.md, consulte A check run menciona o REVIEW.md.