From 95c37fc0173df3942d1ebb2ea582ca6cca82a67b Mon Sep 17 00:00:00 2001 From: Aryan Jasala Date: Thu, 1 Oct 2026 22:42:19 +0530 Subject: [PATCH] docs(php-packages): add README headers and point contributions at wp-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. --- composer-packages/phpcs/CHANGELOG.md | 7 +++++++ composer-packages/phpcs/README.md | 19 ++++++++++++++++++- composer-packages/phpstan/CHANGELOG.md | 7 +++++++ composer-packages/phpstan/README.md | 20 +++++++++++++++++--- 4 files changed, 49 insertions(+), 4 deletions(-) diff --git a/composer-packages/phpcs/CHANGELOG.md b/composer-packages/phpcs/CHANGELOG.md index fdba6c0..f974013 100644 --- a/composer-packages/phpcs/CHANGELOG.md +++ b/composer-packages/phpcs/CHANGELOG.md @@ -4,6 +4,13 @@ All notable changes to `rtcamp/wp-phpcs` are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). +## [Unreleased] + +### Changed + +- README: a header with the license, PHP and tool-version badges, and a note that the + mirror repository is read-only and issues and pull requests go to rtCamp/wp-tooling. + ## [1.0.0] - 2026-07-30 ### Added diff --git a/composer-packages/phpcs/README.md b/composer-packages/phpcs/README.md index 212f770..19a06f4 100644 --- a/composer-packages/phpcs/README.md +++ b/composer-packages/phpcs/README.md @@ -1,4 +1,21 @@ -# rtCamp WordPress PHPCS standards (`rtcamp/wp-phpcs`) +

wp-phpcs

+ +

+ License: GPL-2.0-or-later + PHP 8.2+ + PHP_CodeSniffer 3.x +

+ +

+ rtCamp's PHP_CodeSniffer standards for WordPress projects + (rtcamp/wp-phpcs): rtCampWP-Basic and the stricter rtCampWP. +

+ +--- + +> **Developed in [rtCamp/wp-tooling](https://github.com/rtCamp/wp-tooling/tree/main/composer-packages/phpcs).** +> The [`rtCamp/wp-phpcs`](https://github.com/rtCamp/wp-phpcs) repository is a read-only mirror, split from +> there on each release. Please open issues and pull requests in wp-tooling. Shared PHP_CodeSniffer standards for rtCamp WordPress projects. Each skeleton (plugin, theme, and future tracks) extends one of these instead of copying — and drifting — a long PHPCS diff --git a/composer-packages/phpstan/CHANGELOG.md b/composer-packages/phpstan/CHANGELOG.md index fe02320..83244af 100644 --- a/composer-packages/phpstan/CHANGELOG.md +++ b/composer-packages/phpstan/CHANGELOG.md @@ -4,6 +4,13 @@ All notable changes to `rtcamp/wp-phpstan` are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). +## [Unreleased] + +### Changed + +- README: a header with the license, PHP and tool-version badges, and a note that the + mirror repository is read-only and issues and pull requests go to rtCamp/wp-tooling. + ## [1.0.0] - 2026-07-30 ### Added diff --git a/composer-packages/phpstan/README.md b/composer-packages/phpstan/README.md index 8f23f1f..d19f6fe 100644 --- a/composer-packages/phpstan/README.md +++ b/composer-packages/phpstan/README.md @@ -1,8 +1,22 @@ -# rtcamp/wp-phpstan +

wp-phpstan

-rtCamp's shared [PHPStan](https://phpstan.org/) baseline for WordPress projects. +

+ License: GPL-2.0-or-later + PHP 8.2+ + PHPStan 2.x +

+ +

+ rtCamp's shared PHPStan baseline for WordPress projects (rtcamp/wp-phpstan). +

+ +--- + +> **Developed in [rtCamp/wp-tooling](https://github.com/rtCamp/wp-tooling/tree/main/composer-packages/phpstan).** +> The [`rtCamp/wp-phpstan`](https://github.com/rtCamp/wp-phpstan) repository is a read-only mirror, split from +> there on each release. Please open issues and pull requests in wp-tooling. -It ships a single `phpstan.neon.dist` of rtCamp defaults (level 5, WordPress-aware +This package ships a single `phpstan.neon.dist` of rtCamp defaults (level 5, WordPress-aware rules) and pulls in [`szepeviktor/phpstan-wordpress`](https://github.com/szepeviktor/phpstan-wordpress), which loads the WordPress function stubs and dynamic return-type extensions PHPStan needs to understand core.