Revisão de código

Revisão de pull requests

O plugin Revisão de código mostra a descrição, os arquivos alterados, os comentários e as verificações de um pull request. Use o plugin para investigar possíveis problemas antes de aprovar o pull request.

A revisão de código no GitHub está disponível para todos. O suporte a merge requests do GitLab no plugin Revisão de código está em prévia. Para iniciar revisões na nuvem pelo GitLab com @codex review ou usar revisões automáticas de merge requests, consulte Como revisar merge requests do GitLab com o Codex.

Para revisões iniciadas pelo repositório, consulte o guia de integração com o GitHub e as instruções de configuração do ambiente do Codex Cloud (legado).

O aplicativo para desktop inclui o plugin Revisão de código. Na lista de plugins instalados, você pode fixá-lo na barra lateral do aplicativo.

Abrir um pull request

1. Abra Revisão de código na barra lateral.
2. Quando solicitado, conecte sua conta do provedor de código. Use uma conta com acesso ao repositório que você quer revisar.
3. Selecione um pull request na barra lateral ou insira o link dele no campo de busca.
4. Em Resumo, consulte a descrição, a atividade, os comentários e as verificações. Abra Alterações para examinar os arquivos alterados e os comentários junto ao diff.

Encontrar revisões que precisam de atenção

Use sua caixa de entrada pessoal para encontrar pull requests de diferentes repositórios do GitHub. Selecione Atribuídos a mim para ver os pedidos de revisão que você recebeu, Atribuídos à minha equipe para ver os pedidos que sua equipe recebeu ou Criados por mim para voltar às suas próprias alterações. Confira o status da revisão e abra o pull request para examinar os comentários e as verificações.

Para voltar a uma revisão mais tarde, selecione o ícone de alfinete na barra de ferramentas da revisão. O pull request aparece em Fixados na barra lateral.

Examinar arquivos alterados e pull requests relacionados

Em Alterações, selecione Marcar como visto no arquivo depois de revisá-lo. Selecione a opção novamente para remover a marcação. As marcações valem para a versão exibida.

Quando as alterações estiverem distribuídas entre pull requests que dependem uns dos outros, use Pilha em Resumo para abrir um pull request relacionado e examinar o diff, os comentários e as verificações. Essa seção aparece quando o plugin Revisão de código encontra uma pilha de pull requests abertos.

Consultar uma revisão automática na nuvem

Com o conector do Codex para o ChatGPT, as permissões necessárias no repositório e as revisões automáticas ativadas, o Codex pode revisar um pull request do GitHub antes que você o abra. Os comentários aparecem no GitHub e no plugin Revisão de código.

Para usar a revisão na nuvem, você não precisa criar nem gerenciar um ambiente de nuvem. Para saber mais sobre os requisitos de conexão, as configurações do repositório e as revisões iniciadas com @codex review, consulte Como usar o Codex no GitHub.

Confira no diff os pontos levantados na revisão. As revisões automáticas na nuvem são independentes das revisões que você inicia no chat do pull request.

Fazer perguntas sobre a alteração

No chat do pull request, descreva o comportamento esperado e peça ao Codex que explique ou investigue a alteração.

Selecione Revisar com o Codex para iniciar uma revisão em um novo chat. Se o pull request estiver aberto ao lado de um chat existente, use esse chat para fazer perguntas sobre a alteração.

Use as habilidades instaladas e as fontes conectadas para disponibilizar ao Codex as diretrizes de revisão ou os documentos de design da equipe. Peça ao Codex que resuma a alteração e explique os riscos. Depois, confira o contexto e o código que ele cita.

Por exemplo, um pull request adiciona os filtros Abertas e Fechadas a um quadro de issues. Você espera que Todas continue sendo o filtro padrão e que o quadro mostre um estado vazio quando nenhuma issue corresponder ao filtro:

Explique passo a passo o que muda neste pull request. Concentre-se no filtro padrão
e no que acontece quando nenhuma issue corresponde ao filtro. O filtro "Todas"
deve continuar sendo o padrão.

Peça evidências:

Mostre o fluxo de execução do código quando nenhuma issue corresponde ao filtro
e os testes para esse caso. Explique o que os testes cobrem e o que ainda falta verificar.

Compare o diff e os testes citados com o comportamento esperado.

Selecione um ponto levantado na revisão para ler a explicação e examinar as linhas correspondentes em Alterações. Antes de decidir se é preciso corrigi-lo, confira o diff mais recente, o comportamento esperado e os testes. Use o chat da revisão para interromper uma revisão em andamento.

Personalizar a revisão

Selecione o ícone de engrenagem de Instruções de revisão ao lado de Revisar com o Codex. Você também pode editar essas instruções em Configurações > Revisão de código.

Informe ao Codex os critérios e o formato de apresentação dos resultados que você quer usar em todas as revisões. Por exemplo:

Comece com um breve resumo. Priorize mudanças de comportamento, perda de dados
e casos extremos para os quais faltam testes. Para cada problema identificado,
explique qual entrada o provoca, o que deveria acontecer e o que acontece de fato.
Siga o estilo conciso que nossa equipe usa nas revisões.

Essas instruções valem para as revisões que você inicia com Revisar com o Codex em qualquer repositório. Se você editar as instruções durante uma revisão, as alterações passam a valer na próxima. Use o chat do pull request para perguntas específicas sobre uma alteração.

Se quiser, selecione História em quadrinhos, Visualização ou PDF para adicionar uma instrução sugerida que pede uma explicação da alteração nesse formato. Edite o texto conforme necessário e selecione Salvar ou Executar revisão.

Compartilhar comentários e acompanhar a revisão

Revisar um pull request no chat não publica comentários, não aprova o pull request nem faz o merge. Você escolhe quais pontos compartilhar.

Depois de confirmar um problema, peça ao Codex que ajude a preparar um comentário de revisão:

Redija um comentário seguindo as diretrizes de revisão da equipe que discutimos.
Descreva o que observamos quando nenhuma issue corresponde ao filtro, o que deveria
acontecer nesse caso e qual teste cobriria o comportamento esperado. Mantenha o
comentário como rascunho, sem publicá-lo.

Antes de publicar, confira se o rascunho cita os arquivos e as linhas corretos. Mantenha os rascunhos no chat até decidir publicá-los. Publicar em Resumo ou Alterações envia o comentário imediatamente ao provedor de código, sem esperar que você selecione Enviar revisão.

Use Enviar revisão para escolher Comentar, Aprovar ou Solicitar alterações e enviar a revisão ao provedor de código. Antes de enviar, confira a decisão selecionada e o comentário da revisão.

Se você criou o pull request, volte a ele e peça ao Codex que atenda a comentários específicos. Examine as alterações resultantes e execute os testes pertinentes. Antes de aprovar ou fazer o merge, confira a versão mais recente, as verificações e os comentários pendentes.

O plugin Revisão de código não permite editar descrições de pull requests que tenham imagens anexadas. Para editar essas descrições, abra o pull request no GitHub.

Continuar em um chat

Quando a seção Resumo mostrar Conversas, selecione um dos chats vinculados para retomar a conversa. Esses são os seus chats associados ao pull request.

No Codex, selecione Corrigir em Verificações de um pull request aberto para anexar ao chat as verificações que falharam. Isso prepara uma mensagem sem enviá-la. Revise ou adicione seu prompt e envie a mensagem para pedir ao Codex que investigue a falha. Examine as alterações resultantes e execute novamente os testes pertinentes antes de enviar a correção ao repositório remoto.

Os diagnósticos disponíveis dependem do provedor da verificação. No caso de CI de terceiros, o Codex pode usar o status e a saída informados ao GitHub.

No ChatGPT Work, envie o código que você quer revisar ou disponibilize-o por meio de um plugin de acesso ao código-fonte já instalado. No prompt, identifique o pull request, a branch, o commit, os arquivos e os critérios de revisão.

Revisar no aplicativo

Abra o painel de revisão para entender o que mudou, comentar linhas específicas e decidir quais alterações preparar, reverter, incluir em um commit ou enviar ao repositório remoto.

Para pedir ao Codex que revise as alterações, digite /review no editor de mensagens. Escolha Revisar em relação a uma branch base ou Revisar alterações sem commit. O Codex apresenta os pontos encontrados por ordem de prioridade, sem modificar sua árvore de trabalho.

O painel de revisão exige que o projeto esteja em um repositório Git. Se o projeto ainda não for um repositório Git, o aplicativo solicitará que você crie um.

Digite /review para abrir as opções predefinidas de revisão da CLI. O Codex inicia um revisor dedicado que lê o diff selecionado e apresenta, por ordem de prioridade, pontos que você pode resolver, sem modificar sua árvore de trabalho.

Digite /review no editor de mensagens da extensão para IDE. Escolha Revisar em relação a uma branch base ou Revisar alterações sem commit. O Codex apresenta os pontos encontrados por ordem de prioridade, sem modificar sua árvore de trabalho.

O comando /review só aparece quando o projeto aberto está em um repositório Git.

Indique no prompt o pull request, a branch, o commit ou os arquivos que você quer examinar. Para revisar arquivos locais que não estejam disponíveis por meio de um plugin de acesso ao código-fonte instalado, envie-os ao chat.

Quais alterações aparecem no painel

O painel de revisão reflete o estado do repositório Git. Ele mostra tanto as alterações feitas pelo Codex quanto as que você fez e quaisquer outras alterações no repositório que ainda não entraram em um commit.

Por padrão, o painel de revisão mostra as alterações em Não preparadas. Use Preparadas para ver o índice do Git, Commit para ver um commit selecionado, Branch para ver o diff em relação à branch base ou Último turno para ver o turno mais recente do assistente.

Revisar vários repositórios

Quando um projeto local inclui várias pastas de diferentes repositórios Git, o painel de revisão pode mostrar as alterações de cada repositório. Abra o seletor de repositório no cabeçalho da revisão para examinar outro repositório e ver as linhas adicionadas ou removidas sem sair do painel atual.

Escolha Último turno para ver as alterações mais recentes do assistente em todos os repositórios vinculados. Nessa visualização, o seletor mostra Todos os repositórios. Os demais escopos de revisão, como Não preparadas, Preparadas e Branch, se aplicam ao repositório selecionado.

Escolha um destes escopos para /review:

• Revisar em relação a uma branch base identifica o ancestral comum usado como base para o merge e revisa o diff da sua branch.
• Revisar alterações sem commit inclui arquivos preparados, não preparados e não rastreados.
• Revisar um commit revisa exatamente o conjunto de alterações do commit selecionado.
• Instruções de revisão personalizadas permite direcionar a revisão para os critérios que você definir.

Escolha um destes escopos para /review:

• Revisar em relação a uma branch base compara a branch atual com uma branch que você selecionar.
• Revisar alterações sem commit revisa as alterações na sua árvore de trabalho.

Os pontos levantados na revisão aparecem no chat na Web. Peça evidências, solicite outra revisão com um escopo mais específico ou peça ao ChatGPT que prepare versões revisadas dos arquivos.

Resultados da revisão de código

Os pontos levantados na revisão aparecem como comentários nas linhas correspondentes do painel de revisão.

Por padrão, as revisões são executadas no chat atual. Em Configurações > Geral > Revisão de código, escolha Separado para iniciar um chat de revisão à parte. Consulte as configurações de desenvolvedor.

A revisão aparece como um turno no histórico da sessão. Defina review_model em config.toml se quiser usar nas revisões um modelo diferente do modelo da sessão atual.

Por padrão, a revisão é executada no chat atual. Defina chatgpt.reviewDelivery como detached se quiser que /review inicie um chat de revisão separado. Consulte a referência de configurações da extensão para IDE.

Se você pedir ao ChatGPT que prepare versões revisadas dos arquivos, continuam valendo as ferramentas e as permissões do espaço de trabalho disponíveis para o chat.

Se você pedir ao Codex que aplique as correções identificadas na revisão, valem as suas configurações habituais de sandbox e aprovação.

Navegar pelo painel de revisão

• Clicar no nome de um arquivo geralmente abre o arquivo no editor escolhido. Você pode escolher o editor padrão nas configurações de desenvolvedor.
• Clicar na área de fundo do nome do arquivo expande ou recolhe o diff.
• Clicar em uma linha com a tecla Command pressionada abre essa linha no editor escolhido.
• Você pode preparar as alterações que quer manter ou reverter as que quer descartar.

Comentar linhas específicas

Os comentários por linha permitem registrar feedback diretamente nas linhas correspondentes do diff. Muitas vezes, essa é a maneira mais rápida de indicar ao Codex o que precisa ser corrigido.

Para comentar uma linha:

1. Abra o painel de revisão.
2. Passe o cursor sobre a linha que você quer comentar.
3. Selecione o botão + que aparece.
4. Escreva e envie o comentário.
5. Quando terminar de comentar, volte ao chat e envie uma mensagem.

Como cada comentário está vinculado a uma linha, o Codex consegue responder com mais precisão do que responderia a uma instrução genérica.

O Codex usa os comentários por linha como orientações para a revisão. Depois de comentar, envie uma mensagem que deixe claro o que você quer. Por exemplo, “Atenda aos comentários nas linhas do código e limite as alterações ao mínimo necessário.”

Preparar e reverter arquivos

O painel de revisão inclui ações do Git para que você possa ajustar o diff antes de fazer o commit.

Você pode preparar alterações, retirá-las da área de preparação ou revertê-las nos seguintes níveis:

• Diff inteiro: use os botões de ação no cabeçalho da revisão, como Preparar tudo ou Reverter tudo.
• Por arquivo: prepare um arquivo, retire-o da área de preparação ou reverta suas alterações.
• Por trecho: prepare um único trecho do diff, retire-o da área de preparação ou reverta suas alterações.

Prepare as alterações quando quiser aceitar parte do trabalho. Reverta as que quiser descartar.

Alterações preparadas e não preparadas

No Git, um mesmo arquivo pode ter alterações preparadas e não preparadas. Quando isso acontece, o painel pode mostrar o arquivo nas duas visualizações. Esse é o comportamento normal do Git.