Skip to content

Docs: Expand the back-porting to WP Core guide - #80593

Merged
scruffian merged 4 commits into
trunkfrom
docs/expand-back-merging-guide
Jul 27, 2026
Merged

Docs: Expand the back-porting to WP Core guide#80593
scruffian merged 4 commits into
trunkfrom
docs/expand-back-merging-guide

Conversation

@scruffian

Copy link
Copy Markdown
Contributor

What?

Enrich docs/contributors/code/back-merging-to-wp-core.md with the step-by-step procedure that experienced contributors have accumulated but that hasn't been written down anywhere.

Why?

Today the doc explains when a PHP change needs a Core back-merge but not how to do it. Newer contributors have to reverse-engineer path mappings, PR conventions, and the backport-changelog step from prior PRs. This PR captures the procedure in one place.

How?

The doc gains:

  • No Core Sync Required added to the skip-label list (the label already exists, it just wasn't mentioned here).
  • A new "How to back-merge a PR" section with five numbered steps: identify files, map paths, create the Trac ticket, open the wordpress-develop PR, add the backport-changelog entry.
  • Path-mapping tables covering the five patterns that appear in real backports:
    • Direct-sync files (lib/<subpath>/*.phpsrc/wp-includes/<subpath>/*.php)
    • Compat shims (lib/compat/wordpress-X.Y/*.phpsrc/wp-includes/*.php, apply-diff only)
    • Class files with -gutenberg in the name
    • Aggregator files (lib/media/load.php)
    • PHP unit tests (phpunit/<subpath>/<name>-test.phptests/phpunit/tests/<subpath>/<name>.php)
  • References to real example wordpress-develop PRs so contributors can cross-check.

No existing content is removed; the "Criteria" and "Pull Request Criteria" sections are unchanged.

Testing Instructions

  1. Read the updated doc end-to-end and confirm the path mappings match the pattern of existing backports.
  2. Cross-reference WordPress/wordpress-develop#12324 and #12516 against the path-mapping tables.

Use of AI Tools

This PR was drafted with Claude Code (Anthropic's Sonnet 4.6). The doc content is derived from real backport PRs and the existing make.wordpress.org syncing guidelines. Per the WordPress AI Guidelines, the human author takes responsibility for the content.

Add a "How to back-merge a PR" section with the step-by-step procedure
that was previously tribal knowledge: path mapping rules (direct-sync,
compat shims, class renames, aggregators, tests), the Trac ticket
requirement, the wordpress-develop PR conventions, and the
backport-changelog step.

Also add `No Core Sync Required` to the skip-label list; the label
already exists but was missing from this doc.
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

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: scruffian <scruffian@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>

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

@scruffian scruffian added the [Type] Developer Documentation Documentation for developers label Jul 22, 2026
@scruffian scruffian self-assigned this Jul 22, 2026
@scruffian
scruffian requested a review from Copilot July 22, 2026 18:55
Comment thread docs/contributors/code/back-merging-to-wp-core.md Outdated
Co-authored-by: Ben Dwyer <ben@scruffian.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Expands the contributor documentation for back-merging Gutenberg PHP changes into WordPress Core by adding a step-by-step procedure and common path-mapping patterns, so contributors don’t have to reverse-engineer the process from prior backports.

Changes:

  • Adds No Core Sync Required to the list of labels that exempt a PR from requiring a Core sync/back-merge.
  • Introduces a “How to back-merge a PR” section with a numbered workflow (identify files, map paths, Trac ticket, Core PR, backport-changelog entry).
  • Adds path-mapping tables and links to example wordpress-develop PRs for cross-checking.

Comment thread docs/contributors/code/back-merging-to-wp-core.md Outdated
Comment thread docs/contributors/code/back-merging-to-wp-core.md Outdated
scruffian and others added 2 commits July 22, 2026 15:48
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

Flaky tests detected in 3ba4996.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/29952567704
📝 Reported issues:

@scruffian scruffian changed the title Docs: Expand the back-merging to WP Core guide Docs: Expand the back-porting to WP Core guide Jul 23, 2026
@scruffian
scruffian requested a review from t-hamano July 27, 2026 19:14
@scruffian
scruffian merged commit 97121b0 into trunk Jul 27, 2026
44 checks passed
@scruffian
scruffian deleted the docs/expand-back-merging-guide branch July 27, 2026 19:30
@github-actions github-actions Bot added this to the Gutenberg 23.7 milestone Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants