Repository navigation
Update/merge docs - #511
Conversation
|
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 #511 +/- ##
==========================================
Coverage 69.17% 69.17%
Complexity 981 981
==========================================
Files 63 63
Lines 4649 4649
==========================================
Hits 3216 3216
Misses 1433 1433
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:
|
Co-authored-by: Darin Kotter <darin.kotter@gmail.com>
github-project-automation
Bot
moved this from Needs review
to Done
in WordPress AI Roadmap
|
|
||
| An example of a squash merge from #359 can be seen in 4c9699f, while an example of the prior approach of a merge commit from #311 can be seen in e63d8c0. | ||
|
|
||
| ### Squash Merge Commit Titles |
There was a problem hiding this comment.
One thing I realized while working on another PR is often we have multiple changelog entries from a single PR (say we fixed on thing, changed one thing). Would we want all of those in the title? And if not, risk of losing those if we're just scanning commit history and not looking at the changelog entries on each PR
There was a problem hiding this comment.
Bah, great point. That's a regular enough occurrence, that maybe we do one of:
- revert to a reasonable PR title as the squash merge commit title
- add other changelog entries at the top of the squash merge commit description
- something else?
The "right" answer feels like option 1 and adding all changelog entries at the top of the commit description?
There was a problem hiding this comment.
Yeah, my preference would be to have the commit title be a more generic overview of what the PR does (maybe even just leaving that to auto-populate the PR title). And then have the changelog entries in the description with props below that (and likely removing the individual commit messages that auto-populate there). But don't feel super strongly on that, defer to whatever makes the most sense on your end
There was a problem hiding this comment.
Yeah, I'm happy with that, updated PR incoming...
* add section for setting squash merge commit titles with changelog entry --------- Co-authored-by: dkotter <dkotter@git.wordpress.org>
What?
This PR updates the docs to call out how best to format squash merge commit titles to help with reviewing changes in
developas well as in building releases.Copilot summary
This pull request updates project documentation to clarify development workflows and changelog conventions. The main changes include improvements to the changelog entry section in the pull request template, removal of the table of contents from the developer guide, and detailed guidance on squash merge strategies and commit titling.
Documentation and workflow improvements:
.github/PULL_REQUEST_TEMPLATE.mdto clarify the categories for PR summaries, and renamed "Development Update" to "Developer" for consistency.docs/DEVELOPER_GUIDE.mdto streamline the introduction and focus on the content.Merge strategy and commit guidelines:
docs/DEVELOPER_GUIDE.mdon using squash merges, including disabling merge commits and rebase merging, and advice on curating commit messages for clarity.docs/DEVELOPER_GUIDE.mdexplaining how to set squash merge commit titles to match the PR changelog entry, with examples and rationale for maintaining clear commit history and release notes.Why?
How?
Use of AI Tools
Testing Instructions
Screenshots or screencast
Changelog Entry