Revisão de código do Codex no GitHub

Utilize a revisão de código do Codex para obter uma análise adicional de elevada relevância nos pull requests do GitHub. O Codex analisa as diferenças do pull request, segue as diretrizes do seu repositório e publica uma revisão de código padrão do GitHub centrada em problemas graves.

Antes de começar

Certifique-se de que tem:

• O Codex cloud configurado para o repositório que pretende rever.
• Acesso às definições de revisão de código do Codex.
• Um ficheiro AGENTS.md, caso pretenda que o Codex siga diretrizes de revisão específicas do repositório.

Configurar a revisão de código do Codex

1. Configure o Codex cloud.
2. Aceda às definições do Codex.
3. Ative Code review para o seu repositório.

Solicitar uma revisão do Codex

1. Num comentário de um pull request, mencione @codex review.
2. Aguarde que o Codex reaja (👀) e publique uma revisão.

O Codex publica uma revisão no pull request, tal como faria um colega de equipa. No GitHub, o Codex assinala apenas problemas P0 e P1, para que os comentários da revisão se mantenham centrados nos riscos de alta prioridade.

Ativar revisões automáticas

Se pretender que o Codex reveja automaticamente todos os pull requests, ative Automatic reviews nas definições do Codex. O Codex publicará uma revisão sempre que alguém abrir um novo PR para revisão, sem necessitar de um comentário @codex review.

Personalizar o que o Codex revê

O Codex procura ficheiros AGENTS.md no seu repositório e segue as regras de revisão de código aplicáveis. Adicione uma secção ## Code Review Rules ao ficheiro mais próximo do código ao qual as regras se aplicam. Utilize títulos ### para agrupar verificações relacionadas quando for útil.

Por exemplo, um serviço de relatórios de experiências pode impedir que o comportamento pós-exposição altere um grupo de comparação:

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

Coloque as regras aplicáveis a todo o repositório no ficheiro AGENTS.md da raiz e as regras específicas do serviço num ficheiro aninhado, como services/experiment_reporting/AGENTS.md. O Codex aplica as diretrizes da raiz e as diretrizes mais específicas que abrangem cada ficheiro alterado, para que alterações não relacionadas não tenham de incluir contexto específico do serviço.

Comece com duas ou três regras concisas que codifiquem verificações frequentemente explicadas pelos revisores. Regras úteis:

• Concentre-se em comportamentos importantes e específicos do repositório. Descreva a restrição de compatibilidade, o limite dos dados ou o efeito secundário inseguro a assinalar e por que motivo é importante.
• Indique o percurso seguro ou a exceção. Forneça ao Codex contexto suficiente para distinguir um problema real de um comportamento esperado.
• Mantenha as regras delimitadas e duradouras. Dê preferência aos resultados em vez de nomes de funções que podem mudar e coloque as diretrizes junto do código ao qual se aplicam.
• Deixe as verificações mecânicas no CI. Exclua das regras de revisão a formatação, o lint e outras verificações determinísticas.

Abra um pull request representativo e solicite uma revisão com @codex review. Aperfeiçoe as regras com base nas conclusões e nos comentários que observar e restrinja ou remova as diretrizes que gerem ruído.

As regras de revisão de código orientam o Codex; não substituem testes, proteções de branches nem aprovações obrigatórias.

Para definir um foco pontual, adicione-o ao comentário do pull request:

@codex review for security regressions

Agir com base nas conclusões da revisão

Depois de o Codex publicar uma revisão, pode pedir-lhe que corrija os problemas no mesmo pull request deixando outro comentário:

@codex fix the P1 issue

O Codex inicia uma conversa na cloud com o pull request como contexto e pode enviar uma correção de volta para a branch quando tiver permissão para o fazer.

Atribuir outras tarefas ao Codex

Se mencionar @codex num comentário com algo diferente de review, o Codex inicia uma conversa na cloud utilizando o seu pull request como contexto.

@codex fix the CI failures

Resolver problemas da revisão de código

Se o Codex não reagir nem publicar uma revisão:

• Confirme que ativou Code review para o repositório nas definições do Codex.
• Confirme que o pull request pertence a um repositório com o Codex cloud configurado.
• Utilize o acionador exato @codex review num comentário do pull request.
• Para revisões automáticas, verifique se ativou Automatic reviews e se o evento do pull request corresponde às suas definições de acionamento da revisão.