Skip to content

Add CONTRIBUTING.md linking to the Playground handbook - #4288

Merged
fellyph merged 3 commits into
WordPress:trunkfrom
swcidd:trunk
Sep 22, 2026
Merged

fellyph merged 3 commits into
WordPress:trunkfrom
swcidd:trunk

Conversation

@swcidd

@swcidd swcidd commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Motivation for the change, related issues

  • No open issue tracks this specifically. The repo has no root-level CONTRIBUTING.md, so GitHub doesn't surface any contributor guidance automatically when someone opens an issue or PR. This adds one that points to the existing Playground Handbook rather than duplicating it.

Implementation details

  • No code changes — adds a single CONTRIBUTING.md at the repo root. It gives a short summary of the ways to contribute (code, docs, translations, triage, ideas), each linking to the corresponding page in the Playground Handbook (developer.wordpress.org/playground/handbook/contributing/), plus the Code of Conduct and GPL licensing note.

Testing Instructions (or ideally a Blueprint)

  • Documentation-only change, nothing to run. To verify: confirm the file renders correctly on GitHub and that all linked handbook and GitHub URLs resolve.

Summary by CodeRabbit

  • Documentation
    • Added a contributor guide for WordPress Playground.
    • Documented contribution types, handbook resources, code of conduct, licensing, and guidance for AI coding agents.

swcidd added 3 commits August 28, 2026 13:54
Add CONTRIBUTING.md with setup, conventions, and PR guidelines

The repo has no root-level CONTRIBUTING.md; contributor info is
scattered across the README, the docs site, and AGENTS.md. This
consolidates fork/clone/build steps, coding and testing
conventions, the PR and GPL licensing process, and links to the
existing docs pages into one file GitHub surfaces automatically
when someone opens an issue or PR.
Add a root-level CONTRIBUTING.md so GitHub surfaces contributor
guidance automatically on new issues and PRs. It gives a short
summary of the ways to contribute (code, docs, translations,
triage, ideas) and links each one out to the corresponding page
in the Playground Handbook
(developer.wordpress.org/playground/handbook/contributing/),
along with the Code of Conduct and GPL licensing terms.
@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8c5e616b-1164-47bc-af5c-def78ea02025

📥 Commits

Reviewing files that changed from the base of the PR and between 3144994 and 472649a.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

Added CONTRIBUTING.md with guidance for contribution types, community standards, licensing, and AI coding agent setup.

Changes

Contributor Documentation

Layer / File(s) Summary
Contribution guidance and project conventions
CONTRIBUTING.md
Documents contribution paths, project resources, code of conduct, GPLv2-or-later licensing, and AGENTS.md guidance.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 47264

This documentation-only change adds contributor guidance without affecting product behavior or production systems. No actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a root-level CONTRIBUTING.md file with a link to the Playground handbook.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@fellyph fellyph left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@fellyph
fellyph merged commit d9a62c8 into WordPress:trunk Sep 22, 2026
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants