Repository navigation
docs(php-packages): add README headers and point contributions at wp-tooling - #74
Merged
Merged
Conversation
…tooling The wp-phpcs and wp-phpstan READMEs are also the mirror repositories' and Packagist's front pages. Each now opens with the same header as wp-primitives (license, PHP and tool-version badges, a one-line summary) and says the mirror is read-only, so issues and pull requests come to this repository.
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation is accurate, consistent with package constraints, and uses valid repository links.
Review effort: Balanced
Findings: None
What changed in this PR
Adds consistent package headers and clarifies that development occurs in the wp-tooling monorepo.
Changes:
- Adds centered titles, metadata badges, and summaries.
- Directs contributions away from read-only mirrors.
- Records these updates under
[Unreleased].
| File | Description |
|---|---|
composer-packages/phpcs/README.md |
Adds PHPCS package header and contribution notice. |
composer-packages/phpcs/CHANGELOG.md |
Records the README update. |
composer-packages/phpstan/README.md |
Adds PHPStan package header and contribution notice. |
composer-packages/phpstan/CHANGELOG.md |
Records the README update. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
AnuragVasanwala
requested review from
AnuragVasanwala
and removed request for
AnuragVasanwala
October 1, 2026 17:15
AnuragVasanwala
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
rtCamp/wp-phpcsandrtCamp/wp-phpstanREADMEs are split fromcomposer-packages/*/README.md, and they double as the Packagist pages. This gives both:[Unreleased]CHANGELOG entry per packageWhy the mirrors look older than this
The mirrors still show the
v1.0.0split from 2026-07-29. The License section with the rtCamp banner and theLICENSEfiles were added here on 2026-07-30 (8235ccb), and nov*tag has been cut since. They reach the mirrors with the next release:resync_branchrepair for the bot commit on both mirrors)release-php.ymlwithresync_branch=truev1.1.0That release also carries this PR and the Packagist metadata from #72, ahead of the Packagist submission.