For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Theme
Codex

Codex use case

Revise pull requests no GitHub

Detecte regressões e possíveis problemas antes da revisão humana.

Difficulty Easy
Time horizon 5s

Use a revisão de código do Codex no GitHub para apontar automaticamente regressões, testes que faltam e problemas de documentação diretamente no pull request.

Best for

  • Equipes que querem uma revisão adicional antes de alguém aprovar o merge
  • Projetos em produção com grandes bases de código

Contents

    ← All use cases

    Revise pull requests no GitHub

    Detecte regressões e possíveis problemas antes da revisão humana.

    Use a revisão de código do Codex no GitHub para apontar automaticamente regressões, testes que faltam e problemas de documentação diretamente no pull request.

    Easy
    5s

    Use a revisão de código do Codex no GitHub para apontar automaticamente regressões, testes que faltam e problemas de documentação diretamente no pull request.

    Easy
    5s

    Best for

    • Equipes que querem uma revisão adicional antes de alguém aprovar o merge
    • Projetos em produção com grandes bases de código

    Skills & Plugins

    • Concentre a revisão em áreas de risco, como o uso de segredos, os mecanismos de autenticação e autorização e as alterações nas dependências.
    Skill Why use it
    Security Best Practices Concentre a revisão em áreas de risco, como o uso de segredos, os mecanismos de autenticação e autorização e as alterações nas dependências.

    Starter prompt

    @codex review procure regressões de segurança, identifique testes que faltam e verifique se alguma mudança de comportamento traz riscos.
    cloud
    @codex review procure regressões de segurança, identifique testes que faltam e verifique se alguma mudança de comportamento traz riscos.
    cloud

    Como usar

    Para começar, adicione a revisão de código do Codex à sua organização ou ao seu repositório no GitHub. Para saber mais, consulte Revisão de código do Codex no GitHub.

    Você pode configurar o Codex para revisar automaticamente cada pull request ou solicitar uma revisão com @codex review em um comentário no pull request.

    Defina regras para a revisão

    Para personalizar o que o Codex revisa, adicione a seção ## Code Review Rules ao arquivo AGENTS.md mais próximo do código ao qual as regras se aplicam. Veja um exemplo.

    ## Code Review Rules
    
    ### Coortes do experimento
    
    - Ao comparar os grupos de tratamento, não filtre os participantes com base em comportamentos posteriores à exposição, como conversão ou retenção.
      Para fazer a comparação com segurança, forme as coortes com base na alocação dos participantes aos grupos ou na exposição ao tratamento. Apresente a conversão como um desfecho do experimento.

    Coloque as regras que valem para todo o repositório no arquivo AGENTS.md da raiz e as regras específicas de cada serviço em um arquivo no subdiretório correspondente. Escreva regras concisas, indique qual comportamento o Codex deve sinalizar e descreva eventuais alternativas seguras ou exceções. Deixe as verificações de formatação e lint a cargo da CI. Para saber como configurar a revisão e escrever as regras, consulte Personalize o que o Codex revisa.

    Related use cases