Use a revisão de código do Codex para ter uma análise adicional dos pontos mais importantes nos pull requests do GitHub. O Codex analisa o diff do pull request, segue as orientações do repositório e publica uma revisão de código no formato padrão do GitHub, com foco em issues graves. A revisão de segurança, disponível em prévia de pesquisa, analisa mais a fundo possíveis issues de segurança em um pull request.
Antes de começar
Verifique se você tem:
- Um repositório do GitHub conectado ao Codex. Para configurar a integração legada, consulte Codex Cloud (legado).
- Acesso às configurações de revisão de código do Codex.
- Um arquivo
AGENTS.md, caso queira que o Codex siga orientações de revisão específicas do repositório.
Configure a revisão de código do Codex
Para configurar revisões automáticas, você precisa de um repositório do GitHub conectado ao Codex e de permissão de push ou de administrador no GitHub para alterar essas configurações.
- Conecte seu repositório do GitHub ao Codex.
- Acesse as configurações do Codex.
- Selecione seu repositório e ative Revisão automática em Revisar código.
Solicite uma revisão do Codex
- Em um comentário no pull request, mencione
@codex review. - Aguarde o Codex reagir com 👀 e publicar a revisão.
O Codex publica a revisão no pull request, como faria alguém da sua equipe. No GitHub, o Codex sinaliza apenas issues P0 e P1 para concentrar os comentários da revisão nos riscos de alta prioridade.
Ative as revisões automáticas
Para ativar as revisões automáticas dos seus pull requests, ative Revisão automática em Preferências pessoais nas configurações do Codex. Escolha quando executar as revisões em Gatilho de revisão. Essa configuração se aplica aos repositórios com revisão de código ativada e dispensa o comentário @codex review.
Personalize o que o Codex revisa
O Codex procura arquivos AGENTS.md no repositório e segue as regras de revisão de código aplicáveis. Adicione uma seção ## Code Review Rules ao arquivo mais próximo do código ao qual as regras se aplicam. Quando for útil, use títulos ### para agrupar verificações relacionadas.
Por exemplo, um serviço que gera relatórios de experimentos pode usar uma regra para evitar que o comportamento após a exposição altere a composição de uma coorte de comparação:
## Code Review Rules
### Coortes de experimentos
- Ao comparar os grupos de tratamento, não filtre os participantes com base no comportamento após a exposição, como conversão ou retenção.
Para fazer a comparação com segurança, forme as coortes com base na alocação aos grupos ou na exposição e apresente a conversão como resultado.Coloque as regras gerais do repositório no AGENTS.md da raiz e as regras de cada serviço em um arquivo dentro do diretório correspondente, como services/experiment_reporting/AGENTS.md. Para cada arquivo alterado, o Codex aplica tanto as orientações da raiz quanto as mais específicas que abrangem aquele arquivo. Assim, alterações sem relação com o serviço dispensam o contexto específico dele.
Comece com duas ou três regras concisas que descrevam verificações que os revisores costumam explicar. Para escrever regras úteis:
- Priorize comportamentos específicos do repositório que tenham impacto significativo. Descreva a restrição de compatibilidade, o limite de acesso ou circulação dos dados ou o efeito colateral inseguro que deve ser sinalizado. Explique por que isso importa.
- Indique a abordagem segura ou a exceção. Dê ao Codex contexto suficiente para distinguir uma issue real de um comportamento esperado.
- Escreva regras com escopo claro e que continuem válidas com o tempo. Prefira descrever resultados a citar nomes de funções que podem mudar. Coloque as orientações perto do código ao qual se aplicam.
- Deixe as verificações mecânicas a cargo da CI. Mantenha a formatação, o lint e outras verificações determinísticas fora das regras de revisão.
Abra um pull request representativo e solicite uma revisão com @codex review. Ajuste as regras com base nos resultados e no feedback recebido. Restrinja o escopo ou remova orientações que gerem comentários irrelevantes.
As regras de revisão de código orientam o Codex. Elas não substituem testes, proteções de branch nem aprovações obrigatórias.
Para direcionar uma revisão específica, indique o foco no comentário do pull request:
@codex review verifique se há problemas na migração do banco de dados
Revisão de segurança
A revisão de segurança é uma revisão adicional para clientes que querem dar atenção especial a issues de segurança em pull requests. Ela examina os riscos de segurança com mais profundidade do que a revisão de código. Para isso, analisa o diff do pull request, o contexto relevante do repositório e os modelos de ameaças ou as orientações de segurança que foram configurados.
A revisão de código também pode identificar issues de segurança durante a análise geral. Por isso, às vezes as duas revisões apontam a mesma issue.
Configure a revisão de segurança
Para consultar instruções mais detalhadas e conhecer as opções de configuração, veja Revisão de segurança.
- Conecte seu repositório do GitHub ao Codex.
- Acesse as configurações do Codex.
- Selecione seu repositório. Em Revisar vulnerabilidades de segurança, ative Revisão de segurança automática e, em Revisar, escolha de quem são os pull requests que receberão revisões. Em Gatilho, selecione Sempre que a revisão de código for executada para executar as duas revisões em conjunto.
Solicite uma revisão de segurança
Para solicitar uma revisão de segurança manualmente, adicione este comentário ao pull request:
@codex security review
O Codex reage ao comentário enquanto a revisão está em andamento e depois publica as issues de segurança identificadas diretamente no pull request. Abra a tarefa correspondente no Codex e selecione a aba Relatório de segurança para ver o relatório completo.
Solucione problemas na revisão de código
Se o Codex não reagir ou não publicar uma revisão:
- Confirme que você ativou a revisão de código para o repositório nas configurações do Codex.
- Confirme que o pull request pertence a um repositório do GitHub conectado ao Codex.
- Use o gatilho exato
@codex reviewem um comentário no pull request. - Para revisões automáticas, verifique a opção Revisão automática nas configurações do repositório e em Preferências pessoais nas configurações do Codex. Confirme que o evento do pull request corresponde ao gatilho de revisão configurado.