jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

[EDI - Builders] - Copilot "How-Tos" ("Create a PR summary") #5528 (#56587)

Browse Source
This commit is contained in:
Anne-Marie
2025-07-14 10:00:52 +01:00
committed by GitHub
parent eae02d5095
commit 7e0666f179
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
content/copilot/how-tos/github-flow/creating-a-pull-request-summary-with-github-copilot.md
View File

@@ -15,20 +15,10 @@ redirect_from:
- /copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot
---
## About {% data variables.copilot.copilot_for_prs %}
## Creating a summary for a pull request
You can use {% data variables.product.prodname_copilot %} to generate a summary of a pull request on {% data variables.product.github %}. You can use the summary to help reviewers understand your changes, or to quickly understand the changes in a pull request you're reviewing.
{% data variables.product.prodname_copilot %} will scan through the pull request and provide an overview of the changes made in prose, as well as a bulleted list of changes with the files that they impact. You can generate a summary in the following places.
* In the description of a new pull request you're creating
* In the description of an existing pull request, by editing the opening comment
* In a comment on the main timeline of a pull request
To learn more about {% data variables.copilot.copilot_for_prs %} and how to use the feature most effectively, see [AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries).
## Creating a summary for a pull request
1. On {% data variables.product.github %}, create a pull request or navigate to an existing pull request.
> [!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.
@@ -52,3 +42,7 @@ To learn more about {% data variables.copilot.copilot_for_prs %} and how to use
1. Add any additional context that will help people viewing your pull request.
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.
## Further reading
* [AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)