Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 21, 2025

Adds guidelines requiring PR descriptions to be at most 3 sentences, with specific guidance for breaking changes.

Changes:

  • Added "Pull Request Description Guidelines" section to AGENTS.md under Contributing
  • Created .github/copilot-instructions.md with PR description best practices
  • Both files specify 3-sentence maximum and require 1-2 sentences describing broken APIs for breaking changes

Example from new guidelines:

**Keep PR descriptions concise and focused:** - Describe your changes in **at most 3 sentences** - Focus on the what and why, not implementation details - If the PR breaks public-facing APIs, use one or two sentences to describe what is broken and how users should adapt
Original prompt

Add instrucitons to both copilot-instructions and agents.md to ask Copilot to only describe at most 3 sentences in PR descriptions. If the PR is breaking public-facing APIs, use one or two sentences to describe what are broken.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Add instructions for PR description length Add PR description length guidelines to agent instructions Nov 21, 2025
Copilot AI requested a review from Mossaka November 21, 2025 17:49
Copilot finished work on behalf of Mossaka November 21, 2025 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants