Repository navigation
docs(readme): align README with the shared README standard - #64
Merged
Merged
Conversation
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.
Summary
Aligns
README.mdwith the shared README standard fromgithub-readme-generator. Documentation only. README 326 → 73 lines; the rule tables moved todocs/rules.md.requireonly. The README states that the latest release 0.5.0 requires PHP^8.5and that^8.4returns with the Unreleased changes.phpcswith the vendor ruleset;phpcbfcarries a warning right next to it that it rewrites files. The.php-only scope andtests/*exclusions sit next to the command.ci.ymlruns on push tomaster), downloads.docs/rules.mdnow matches the 160<rule ref>entries inruleset.xml. Five rules the ruleset does not enable were removed, nine enabled rules were added, and the unsupported "max 500 lines" forClassLengthwas dropped.Follow-ups found (not changed here)
composer.json: "Custom PHPCS ruleset based on Slevomat Coding Standard".psr12keyword incomposer.jsonhas no backing inruleset.xml.ruleset.xml:DisallowMultiConstantDefinitionandDisallowMultiPropertyDefinitionare both enabled and listed in top-level<exclude>;ForbiddenPublicPropertyis declared twice.UnusedSniffCommandprintsSNIFFS_DIRinstead of the ruleset path in "Ruleset file not found".phpunit.xmlexcludesExample, but the directory isExamples.composer-update.ymlusesactions/checkout@v4,ci.ymluses@v5.Verification
All relative links resolve; the rule list in
docs/rules.mdwas diffed againstruleset.xml. No quality gate was run; this is a documentation-only change for manual review.