|
| 1 | +--- |
| 2 | +title: Helping others review your changes |
| 3 | +intro: 'You can use pull requests to provide clear context for your changes and keep your team informed, improving collaboration and the quality of reviews.' |
| 4 | +redirect_from: |
| 5 | + - /pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests |
| 6 | +versions: |
| 7 | + fpt: '*' |
| 8 | + ghes: '*' |
| 9 | + ghec: '*' |
| 10 | +topics: |
| 11 | + - Pull requests |
| 12 | +shortTitle: Help others review your changes |
| 13 | +--- |
| 14 | + |
| 15 | +When you create a pull request, you’re asking your team to review your changes and provide feedback. This guide provides best practices for creating pull requests that are easy to review and keep your team informed, so that you can improve collaboration and the quality of reviews. |
| 16 | + |
| 17 | +## Making your changes easy to review |
| 18 | + |
| 19 | +Clear context in your pull requests helps reviewers quickly see what you’ve changed and why it matters. This makes the review process faster and smoother, with less back-and-forth, and helps your team give better feedback and make confident decisions. For information on creating a pull request, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)." |
| 20 | + |
| 21 | +### Write small PRs |
| 22 | + |
| 23 | +Aim to create small, focused pull requests that fulfill a single purpose. Smaller pull requests are easier and faster to review and merge, leave less room to introduce bugs, and provide a clearer history of changes. |
| 24 | + |
| 25 | +### Review your own pull request first |
| 26 | + |
| 27 | +Review, build, and test your own pull request before submitting it. This will allow you to catch errors or typos that you may have missed, before others start reviewing. |
| 28 | + |
| 29 | +### Provide context and guidance |
| 30 | + |
| 31 | +Write clear titles and descriptions for your pull requests so that reviewers can quickly understand what the pull request does. In the pull request body, include: |
| 32 | + |
| 33 | +* The purpose of the pull request |
| 34 | +* An overview of what changed |
| 35 | +* Links to any additional context such as tracking issues or previous conversations |
| 36 | + |
| 37 | +To help reviewers, share the type of feedback you need. For example, do you need a quick look or a deeper critique?{% ifversion copilot %} Additionally, you can use {% data variables.product.prodname_copilot %} to generate a summary of your pull request. See "[Use {% data variables.product.prodname_copilot %} to generate pull request summaries](#use-github-copilot-to-generate-pull-request-summaries)," later in this article.{% endif %} |
| 38 | + |
| 39 | +If your pull request consists of changes to multiple files, provide guidance to reviewers about the order in which to review the files. Recommend where to start and how to proceed with the review. |
| 40 | + |
| 41 | +## Keeping your team informed |
| 42 | + |
| 43 | +Pull requests can do more than just document code changes—they’re also a powerful way to keep your team and manager informed about the status of your work. By making your progress visible in your pull requests, you can reduce the need for separate updates and ensure everyone stays aligned. |
| 44 | + |
| 45 | +{% ifversion copilot %} |
| 46 | + |
| 47 | +### Use {% data variables.product.prodname_copilot %} to generate pull request summaries |
| 48 | + |
| 49 | +> [!NOTE] {% data reusables.copilot.copilot-requires-subscription %} |
| 50 | +
|
| 51 | +You can use {% data variables.product.prodname_copilot_short %} to generate a summary of a pull request on {% data variables.product.github %}. You can use the summary to help reviewers understand your changes. |
| 52 | + |
| 53 | +1. On {% data variables.product.github %}, create a pull request or navigate to an existing pull request. |
| 54 | + |
| 55 | + > [!NOTE] {% data variables.product.prodname_copilot %} does not take into account any existing content in the pull request description, so it is best to start with a blank description. |
| 56 | +
|
| 57 | +1. Navigate to the text field where you want to add the pull request summary. |
| 58 | + |
| 59 | + * If you're creating a new pull request, use the "Add a description" field. |
| 60 | + * If you're adding a description to an existing pull request, edit the opening comment. |
| 61 | + * If you're adding a summary as a comment, navigate to the "Add a comment" section at the bottom of the pull request page. |
| 62 | + |
| 63 | +1. In the header of the text field, select {% octicon "copilot" aria-label="Copilot actions" %}, then click **Summary**. |
| 64 | + |
| 65 | +  |
| 66 | + |
| 67 | +1. Wait for {% data variables.product.prodname_copilot %} to produce the summary, then check over the results carefully. |
| 68 | +1. Add any additional context that will help people viewing your pull request. |
| 69 | +1. When you're happy with the description, click **Create pull request** on a new pull request, or **Update comment** if you're editing an existing description. |
| 70 | + |
| 71 | +{% endif %} |
| 72 | + |
| 73 | +### Link to related issues or projects |
| 74 | + |
| 75 | +Connect your pull request to relevant issues or project boards to show how your work fits into the larger project. |
| 76 | + |
| 77 | +* Add keywords like `Closes ISSUE-LINK` in your description to automatically link and close the issue when the pull request is merged. |
| 78 | +* Use {% data variables.product.prodname_projects_v2 %} to track your work and link to the project from your pull request, making progress easy to track in one place. See "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." |
| 79 | + |
| 80 | +### Highlight the status with labels |
| 81 | + |
| 82 | +Add a status label to your pull request to show whether it’s ready for review, blocked, or in progress. This helps reviewers understand the state of your work at a glance. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)." |
0 commit comments