Reviewing proposed changes in a pull request

Review commits, file changes, and diffs in pull requests to provide feedback, approve changes, or request updates before merging.

Tool navigation

Dans cet article

About reviewing pull requests

It's best to review changes in a pull request one file at a time:

  • Examine each individual file changed in the pull request.
  • Leave comments on specific changes.
  • After reviewing a file, mark it as Viewed to collapse it and track your progress.
  • The progress bar in the pull request header shows how many files you've viewed.
  • When you've finished, you can approve the pull request or request changes by submitting your review with a summary comment.

Understanding the purpose of the pull request

Understanding the motivation behind a pull request helps you keep your review targeted and meaningful. It also helps you provide feedback that aligns with the pull request author’s intent and the project's goals.

You have several options to better understand the context and rationale for proposed changes.

Using the pull request sidebar for context

In the pull request sidebar, you can find valuable context, including:

  • Linked issues or discussions: Review these to understand the problems or goals that the pull request aims to address. You can also gather information about background, design decisions, or current debates.
  • Linked projects or milestones: Review how this pull request fits within larger projects or upcoming releases.

Use this information to frame your review and check if the goals of the pull request align with the original intent.

Using Discussion avec Copilot to understand the rationale

You can ask Discussion avec Copilot for help understanding the pull request’s intent or clarifying any part of the change.

  1. At the top right of the pull request page, click the button next to the search bar.

    Discussion avec Copilot is displayed, with the pull request attached as context to the prompt window.

  2. In the prompt box, type a question and press Enter. For example, you could enter:

    • What problem does this pull request solve?
    • Why were these changes needed?
    • Summarize the goals of this PR based on the linked issue.
    • How does this PR relate to issue ISSUE-URL?

Discussion avec Copilot can help you clarify the bigger picture before you start line-level review.

Starting a review

  1. Sous le nom de votre référentiel, cliquez sur Demandes de tirage.

    Capture d’écran de la page principale d’un dépôt. Dans la barre de navigation horizontale, un onglet intitulé « Demandes de tirage » est indiqué en orange foncé.

  2. Dans la liste des demandes de tirage, cliquez sur la demande de tirage que vous voulez réviser.

  3. Sur la requête de tirage, cliquez sur Fichiers modifiés.

    Capture d’écran des onglets d’une demande de tirage. L’onglet « Fichiers modifiés » est indiqué en orange foncé. To change the format of the diff view in this tab, click and choose the unified or split view. The choice you make will apply when you view the diff for other pull requests.

    Screenshot of the "Files changed" tab for a pull request. The "Diff view" menu is outlined in dark orange.

    You can also 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.

  5. Pointez sur la ligne de code dans laquelle vous souhaitez ajouter un commentaire, puis cliquez sur l’icône de commentaire bleue.

    Capture d’écran d’une différence dans une demande de tirage. En regard d’un numéro de ligne, une icône plus bleue est mise en évidence avec un contour orange.

  6. Si vous le souhaitez, vous pouvez ajouter un commentaire sur plusieurs lignes. Pour sélectionner une plage de lignes, cliquez sur le numéro de ligne de la première ligne sur laquelle vous souhaitez commenter, puis faites glisser vers le bas vers la ligne finale, ou maintenez la touche Maj enfoncée , puis cliquez sur le dernier numéro de ligne. Vous pouvez ensuite cliquer sur l’icône de commentaire bleu sur la dernière ligne sur laquelle vous souhaitez commenter. Vous pouvez également cliquer sur l’icône de commentaire bleue en regard de la première ligne sur laquelle vous souhaitez commenter, puis faire glisser vers le bas jusqu’à la dernière ligne sur laquelle vous souhaitez commenter.

  7. Entrez votre commentaire dans le champ de commentaire.

  8. Si vous voulez suggérer un changement spécifique pour une ou plusieurs lignes, cliquez sur , puis modifiez le texte dans le bloc de suggestion.

    Capture d’écran d’une zone de révision de commentaire. L’icône de diff de fichier pour suggérer un changement spécifique est indiquée en orange foncé.

  9. Pour commenter directement un fichier, à droite du fichier, cliquez sur et tapez votre commentaire.

    Capture d’écran d’un fichier image dans la page « Fichiers modifiés » d’une demande de tirage. À droite du fichier, une icône de commentaire est mise en évidence en orange.

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

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, click Review changes, then click Abandon review.

Screenshot of the comment field for a review. The "Abandon review" button is outlined in dark orange.

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. You can also check whether the changes introduce security vulnerabilities. See Reviewing dependency changes in a pull request.

  1. Sur la requête de tirage, cliquez sur Fichiers modifiés.

    Capture d’écran des onglets d’une demande de tirage. L’onglet « Fichiers modifiés » est indiqué en orange foncé.

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

    Screenshot of the "Files changed" tab of a pull request. The button to display the rich diff, labeled with a file icon, is outlined in dark orange.

  3. Vous pouvez également examiner le diff source, car il peut y avoir des changements dans le manifeste ou le fichier de verrouillage qui ne modifient pas les dépendances, ou il peut y avoir des dépendances que GitHub ne peut pas analyser et qui, par conséquent, n’apparaissent pas dans l’examen des dépendances.

    Pour revenir à la vue du diff source, cliquez sur le bouton .

    Capture d’écran de l’onglet « Fichiers changés » d’une demande de tirage. Le bouton permettant d’afficher le diff source, représenté par une icône de code, est mis en évidence en orange.

Marking a file as viewed

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

  1. Sur la requête de tirage, cliquez sur Fichiers modifiés.

    Capture d’écran des onglets d’une demande de tirage. L’onglet « Fichiers modifiés » est indiqué en orange foncé.

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

    Screenshot of the header of a file. The "Viewed" option is outlined in dark orange.

Submitting your review

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

  1. Sur la requête de tirage, cliquez sur Fichiers modifiés.

    Capture d’écran des onglets d’une demande de tirage. L’onglet « Fichiers modifiés » est indiqué en orange foncé.

  2. Au-dessus du code modifié, cliquez sur Vérifier les modifications.

    Capture d’écran de l’onglet « Fichiers changés » d’une demande de tirage. Le bouton « Réviser les changements » est indiqué en orange foncé.

  3. Tapez un commentaire résumant vos commentaires sur les modifications proposées.

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

    • 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. Cliquez sur Envoyer la révision.

Conseil

  • L’option Demander des changements est purement informationnelle et n’empêche pas la fusion, sauf si un ensemble de règles ou une règle de protection de branche classique est configuré avec l’option « Exiger une demande de tirage ». Si configuré et qu’un collaborateur disposant d’un accès admin, owner ou write au référentiel envoie une révision demandant des modifications, la demande de tirage ne peut pas être fusionnée tant que ce collaborateur n’a pas soumis une autre révision qui approuve les modifications dans la demande de tirage.
  • Les propriétaires et administrateurs du dépôt peuvent fusionner une demande de tirage, même si celle-ci n’a pas reçu de révision d’approbation, ou si un réviseur qui a demandé des modifications a quitté l’organisation ou n’est pas disponible.
  • Si les révisions requises et l’abandon des révisions obsolètes sont activés et qu’un commit de modification du code est poussé vers la branche d’une demande de tirage approuvée, l’approbation est rejetée. La demande de tirage doit être de nouveau révisée et approuvée avant de pouvoir être fusionnée.
  • Lorsque plusieurs demandes de tirage ouvertes ont chacune une branche de tête (head) pointant vers le même commit, vous ne pouvez pas les fusionner si une ou les deux ont une révision en attente ou rejetée.
  • Les auteurs de demandes de tirage ne peuvent pas approuver leurs propres demandes de tirage.

Further reading