Revise squash merge commit title and description guidelines#521
Conversation
Updated guidelines for squash merge commit titles and descriptions to improve clarity and efficiency in the merging process.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #521 +/- ##
==========================================
Coverage 70.07% 70.07%
Complexity 1107 1107
==========================================
Files 67 67
Lines 5367 5367
==========================================
Hits 3761 3761
Misses 1606 1606
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Updated guidelines for squash merge commit titles and descriptions to improve clarity and efficiency in the merging process.
What?
After discussion starting in #511 (comment), this PR adjusts how squash merge title and description is set.
Copilot summary
This pull request updates the developer documentation to clarify and improve the instructions for writing squash merge commit titles and descriptions. The changes emphasize creating concise, helpful summaries and using changelog entries for commit descriptions.
Documentation improvements:
docs/DEVELOPER_GUIDE.mdto clarify that the commit title should be a clear summary of the change, and the commit description should be based on the PR's changelog entry or a manually generated summary if none exists.Why?
How?
Use of AI Tools
None, besides the generation of the commit message/description.
Testing Instructions
Screenshots or screencast
Changelog Entry
n/a, tag onto the same changelog entry for #511.