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.

Tipp: Du findest einen Pull Request, wenn du oder ein Team, dem du angehörst, mit dem Suchqualifizierer review-requested:[USERNAME] oder team-review-requested:[TEAMNAME] zum Review angefordert wirst. Weitere Informationen findest du unter Durchsuchen von Issues und Pull Requests.

Starting a review

  1. Klicke unter dem Namen deines Repositorys auf Pull Requests. Auswählen der Registerkarte für Issues und Pull Requests

  2. Klicke in der Liste der Pull Requests auf den Pull Request, den Du überprüfen möchtest.

  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. Bewege den Mauszeiger über die Codezeile, der du einen Kommentar hinzufügen möchtest, und klicke auf das blaue Kommentarsymbol. Um mehreren Zeilen einen Kommentar hinzuzufügen, wähle durch Klicken und Ziehen den gewünschten Zeilenbereich aus, und klicke dann auf das blaue Kommentarsymbol. Blaues Kommentarsymbol

  6. Gib im Kommentarfeld Deinen Kommentar ein. Kommentarfeld

  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. Du solltest auch das Quell-Diff überprüfen, da es möglicherweise Änderungen an der Manifest- oder Sperrdatei gibt, die keine Abhängigkeiten ändern. Zudem besteht die Möglichkeit, dass Abhängigkeiten verfügbar sind, die GitHub nicht analysieren kann und die daher nicht in der Abhängigkeitsüberprüfung angezeigt werden.

    Klicke auf die Schaltfläche , um zur Ansicht für das Quell-Diff zurückzukehren.

    Schaltfläche für das Quell-Diff

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. Klicke oberhalb des geänderten Codes auf Änderungen überprüfen. Schaltfläche „Änderungen überprüfen“

  3. Gib einen Kommentar ein, der Dein Feedback für die vorgeschlagenen Änderungen zusammenfasst. Fenster „Kommentar zur Review-Zusammenfassung“

  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. Klicke auf Review senden.

Tipps:

  • Wenn erforderliche Reviews aktiviert sind und ein Mitarbeiter mit Schreib-, Administrator- oder Besitzer-Zugriff auf das Repository einen Review sendet, in dem Änderungen angefordert werden, kann der Pull Request erst gemergt werden, wenn derselbe Mitarbeiter einen weiteren Review sendet, in dem die Änderungen am Pull Request genehmigt werden.
  • Repository-Inhaber und -Administratoren können einen Pull Request sogar dann zusammenführen, wenn er keinen genehmigenden Review erhalten hat oder wenn ein Reviewer, der die Änderungen verlangt hat, die Organisation verlassen hat oder nicht verfügbar ist.
  • Wenn sowohl erforderliche Reviews wie das Verwerfen veralteter Reviews aktiviert sind und ein den Code verändernder Commit an den Branch eines genehmigten Pull Requests übermittelt wird, dann wird die Genehmigung verworfen. Der Pull Request muss erneut überprüft und genehmigt werden, bevor er zusammengeführt werden kann.
  • Wenn verschiedene offene Pull Requests jeweils einen Head-Branch aufweisen, der auf denselben Commit verweist, kannst Du sie nicht zusammenführen, wenn der Review bei einer oder bei beiden ausstehend ist oder abgelehnt wurde.
  • Wenn dein Repository Genehmigungsreviews von Personen mit Schreib- oder Administratorberechtigungen erfordert, werden alle Genehmigungen von Personen mit diesen Berechtigungen mit einem grünen Häkchen markiert, Genehmigungen von Personen ohne diese Berechtigungen erhalten ein graues Häkchen. Genehmigungen mit einem grauen Häkchen wirken sich nicht darauf aus, ob der Pull Request gemergt werden kann.
  • Ersteller von Pull Requests können ihre Pull Requests nicht selbst genehmigen.

Further reading