Skip to main content

Reviewing proposed changes in a pull request

In a pull request, you can review and discuss commits, changed files, and the differences (or "diff") between the files in the base and compare branches.

About reviewing pull requests

You can review changes in a pull request one file at a time. While reviewing the files in a pull request, you can leave individual comments on specific changes. After you finish reviewing each file, you can mark the file as viewed. This collapses the file, helping you identify the files you still need to review. A progress bar in the pull request header shows the number of files you've viewed. After reviewing as many files as you want, you can approve the pull request or request additional changes by submitting your review with a summary comment.

Dica: encontre uma solicitação de pull na qual você ou uma equipe da qual você é membro é solicitada para revisão com o qualificador de pesquisa review-requested:[USERNAME] ou team-review-requested:[TEAMNAME]. Para obter mais informações, confira "Pesquisar problemas e solicitações de pull".

Starting a review

  1. Abaixo do nome do repositório, clique em Solicitações de pull. Seleção da guia Problemas e solicitações de pull

  2. Na lista de solicitações pull, clique na solicitação pull que você quer revisar.

  3. On the pull request, click Files changed. Pull Request Files changed tab

    You can change the format of the diff view in this tab by clicking and choosing the unified or split view. The choice you make will apply when you view the diff for other pull requests.

    Diff view settings

    You can also choose to hide whitespace differences. The choice you make only applies to this pull request and will be remembered the next time you visit this page.

  4. Optionally, filter the files to show only the files you want to review or use the file tree to navigate to a specific file. For more information, see "Filtering files in a pull request."

  5. Passe o mouse sobre a linha de código em que você gostaria de adicionar um comentário e clique no ícone de comentário azul. Para adicionar um comentário em várias linhas, clique e arraste para selecionar o intervalo de linhas e clique no ícone de comentário azul. Ícone de comentário azul

  6. No campo comentário, digite o seu comentário. Campo de comentário

  7. Optionally, to suggest a specific change to the line or lines, click , then edit the text within the suggestion block. Suggestion block

  8. When you're done, click Start a review. If you have already started a review, you can click Add review comment.

    Start a review button

Before you submit your review, your line comments are pending and only visible to you. You can edit pending comments anytime before you submit your review. To cancel a pending review, including all of its pending comments, scroll down to the end of the timeline on the Conversation tab, then click Cancel review.

Cancel review button

You can use GitHub Codespaces to test, run, and review pull requests.

  1. Open the pull request in a codespace, as described in "Opening a pull request."

  2. In the Activity Bar, click the GitHub Pull Request view. This view only appears when you open a pull request in a codespace.

    Option to open PR in a codespace

  3. To review a specific file, click the Open File icon in the Side Bar.

    Option to open PR in a codespace

  4. To add review comments, click the + icon next to the line number. Type your review comment and then click Start Review.

    Option to open PR in a codespace

  5. When you are finished adding review comments, from the Side Bar you can choose to either submit the comments, approve the changes, or request changes.

    Option to open PR in a codespace

For more information on reviewing pull requests in GitHub Codespaces, see "Using GitHub Codespaces for pull requests."

Reviewing dependency changes

If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "Reviewing dependency changes in a pull request."

  1. On the pull request, click Files changed. Pull Request Files changed tab

  2. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button.

    The rich diff button

  3. É possível que você também queira revisar o diff da fonte, porque pode haver alterações no manifesto ou arquivo de bloqueio que não mudam as dependências, ou pode haver dependências que GitHub não pode analisar e que, consequentemente, não aparecem na revisão de dependências.

    Para retornar ao modo de exibição de diferenciação de origem, clique no botão .

    Botão de diff de fonte

Marking a file as viewed

After you finish reviewing a file, you can mark the file as viewed, and the file will collapse. If the file changes after you view the file, it will be unmarked as viewed.

  1. On the pull request, click Files changed. Pull Request Files changed tab

  2. On the right of the header of the file you've finished reviewing, select Viewed.

    Viewed checkbox

Submitting your review

After you've finished reviewing all the files you want in the pull request, submit your review.

  1. On the pull request, click Files changed. Pull Request Files changed tab

  2. Acima do código alterado, clique em Revisar alterações. Botão Revisar alterações

  3. Digite um comentário que resume o seu feedback sobre as alterações propostas. Janela do comentário sobre o resumo da revisão

  4. Select the type of review you'd like to leave:

    Radio buttons with review options

    • Select Comment to leave general feedback without explicitly approving the changes or requesting additional changes.
    • Select Approve to submit your feedback and approve merging the changes proposed in the pull request.
    • Select Request changes to submit feedback that must be addressed before the pull request can be merged.
  5. Clique em Enviar revisão.

Dicas:

  • Se as revisões necessárias estiverem habilitadas e um colaborador com acesso de gravação, administrador ou proprietário no repositório enviar uma revisão solicitando alterações, a solicitação de pull não poderá ser mesclada até que o mesmo colaborador envie outra revisão aprovando as alterações na solicitação de pull.
  • Proprietários e administradores do repositório podem fazer merge de um pull request mesmo que não tenham recebido uma revisão de aprovação; ou se um revisor que solicitou alterações saiu da organização ou estiver indisponível.
  • Se as revisões necessárias e o descarte de uma revisão obsoleta estiverem habilitados e um commit de modificação de código for enviado para o branch de um pull request aprovado, a aprovação será ignorada. O pull request deve ser revisado e aprovado novamente antes de poder ser mesclado.
  • Quando vários pull requests abertos têm um branch principal que aponta para o mesmo commit, você não conseguirá mesclá-los se um ou ambos tiverem uma revisão pendente ou rejeitada.
  • Se o repositório exigir a aprovação de revisões de pessoas com permissões de gravação ou de administrador, todas as aprovações de pessoas com essas permissões serão indicadas com uma marca de seleção verde e as aprovações de pessoas sem essas permissões têm uma marca de seleção cinza. As aprovações com uma marca de seleção cinza não afetam a possibilidade de mesclagem da solicitação de pull.
  • Os autores de pull request não podem aprovar seus próprios pull requests.

Further reading