Skip to content

Strengthen PR description brevity guidelines in copilot-instructions.md#638

Merged
jackfirth merged 3 commits intomasterfrom
copilot/update-pr-description-guidelines
Oct 27, 2025
Merged

Strengthen PR description brevity guidelines in copilot-instructions.md#638
jackfirth merged 3 commits intomasterfrom
copilot/update-pr-description-guidelines

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025

Copilot-generated PR descriptions were excessively verbose. Updated .github/copilot-instructions.md to enforce stricter brevity requirements.

Changes:

  • Changed from "A paragraph or two at most" to "Keep descriptions to a single paragraph"
  • Added explicit limit: "one or two small blocks" of example code maximum
  • Added prohibition against "lengthy, detailed explanations or documentation"
Original prompt

This section details on the original issue you should resolve

<issue_title>Copilot PR descriptions are way too wordy</issue_title>
<issue_description>The copilot-instructions.md file should probably be updated to tell Copilot to be much terser in its PR descriptions. They should be a paragraph at most, with maybe one or two blocks of example code. Not the monstrously long descriptions that they are today, such as in #628.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits October 27, 2025 00:22
Co-authored-by: jackfirth <8175575+jackfirth@users.noreply.github.com>
Co-authored-by: jackfirth <8175575+jackfirth@users.noreply.github.com>
Copilot AI changed the title [WIP] Update copilot-instructions for concise PR descriptions Strengthen PR description brevity guidelines in copilot-instructions.md Oct 27, 2025
Copilot AI requested a review from jackfirth October 27, 2025 00:24
@jackfirth jackfirth marked this pull request as ready for review October 27, 2025 01:23
@jackfirth jackfirth enabled auto-merge (squash) October 27, 2025 01:24
@jackfirth jackfirth merged commit 567ef67 into master Oct 27, 2025
3 checks passed
@jackfirth jackfirth deleted the copilot/update-pr-description-guidelines branch October 27, 2025 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Copilot PR descriptions are way too wordy

2 participants