Skip to content

Revise squash merge commit title and description guidelines#521

Merged
dkotter merged 1 commit into
developfrom
update/merge-docs
May 7, 2026
Merged

Revise squash merge commit title and description guidelines#521
dkotter merged 1 commit into
developfrom
update/merge-docs

Conversation

@jeffpaul
Copy link
Copy Markdown
Member

@jeffpaul jeffpaul commented May 7, 2026

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:

  • Updated the section on squash merge commits in docs/DEVELOPER_GUIDE.md to 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.
  • Removed outdated instructions about keeping or stripping individual commit messages, and instead focused on using changelog entries for the final commit description.
  • Revised the language to stress the importance of this process for easier review and release management.

Why?

How?

Use of AI Tools

None, besides the generation of the commit message/description.

Testing Instructions

Screenshots or screencast

Before After

Changelog Entry

n/a, tag onto the same changelog entry for #511.

Open WordPress Playground Preview

Updated guidelines for squash merge commit titles and descriptions to improve clarity and efficiency in the merging process.
@jeffpaul jeffpaul added this to the 0.9.0 milestone May 7, 2026
@jeffpaul jeffpaul requested a review from dkotter May 7, 2026 17:33
@jeffpaul jeffpaul moved this from Triage to Needs review in WordPress AI Planning & Roadmap May 7, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.07%. Comparing base (3f8aec5) to head (e0e607c).

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           
Flag Coverage Δ
unit 70.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dkotter dkotter merged commit 35fe1b8 into develop May 7, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from Needs review to Done in WordPress AI Planning & Roadmap May 7, 2026
@dkotter dkotter deleted the update/merge-docs branch May 7, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants