Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 27, 2025
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e307d3e
Initial plan
Copilot Oct 27, 2025
c103fe6
Make PR description guidelines more explicit about brevity
Copilot Oct 27, 2025
738f337
Clarify PR description guideline wording
Copilot Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ using `resyntax fix` or `resyntax analyze`, not `raco resyntax fix` or
`raco resyntax analyze`.

When creating a pull request, avoid being overly verbose in the pull
request description. A paragraph or two at most is usually sufficient.
request description. Keep descriptions to a single paragraph. If you need to
include example code, limit it to one or two small blocks. Do not write
lengthy, detailed explanations or documentation in the PR description.

If you want to experiment with new refactoring rules you've created, consider
doing so by cloning the [DrRacket][6], [Herbie][7], or [Typed Racket][8]
Expand Down