Skip to content

docs(readme): align README with the shared README standard - #64

Merged
pekral merged 1 commit into
masterfrom
docs/readme-standard
Nov 12, 2026
Merged

pekral merged 1 commit into
masterfrom
docs/readme-standard

Conversation

@pekral

@pekral pekral commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Summary

Aligns README.md with the shared README standard from github-readme-generator. Documentation only. README 326 → 73 lines; the rule tables moved to docs/rules.md.

  • Plain Markdown header, no emoji headings, no horizontal rules. Order: Requirements → Installation → Configuration → Quick start → Documentation → Testing → Changelog → License.
  • Requirements come from require only. The README states that the latest release 0.5.0 requires PHP ^8.5 and that ^8.4 returns with the Unreleased changes.
  • Quick start runs phpcs with the vendor ruleset; phpcbf carries a warning right next to it that it rewrites files. The .php-only scope and tests/* exclusions sit next to the command.
  • Badges: version, license (static MIT template), CI (new — ci.yml runs on push to master), downloads.
  • Unsupported marketing ("Easy integration with CI/CD…") and the generic FAQ removed.
  • docs/rules.md now matches the 160 <rule ref> entries in ruleset.xml. Five rules the ruleset does not enable were removed, nine enabled rules were added, and the unsupported "max 500 lines" for ClassLength was dropped.

Follow-ups found (not changed here)

  • GitHub About has no description, homepage or topics. Suggested description from composer.json: "Custom PHPCS ruleset based on Slevomat Coding Standard".
  • The psr12 keyword in composer.json has no backing in ruleset.xml.
  • ruleset.xml: DisallowMultiConstantDefinition and DisallowMultiPropertyDefinition are both enabled and listed in top-level <exclude>; ForbiddenPublicProperty is declared twice.
  • UnusedSniffCommand prints SNIFFS_DIR instead of the ruleset path in "Ruleset file not found".
  • phpunit.xml excludes Example, but the directory is Examples.
  • composer-update.yml uses actions/checkout@v4, ci.yml uses @v5.
  • Missing community files: CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, PR template.

Verification

All relative links resolve; the rule list in docs/rules.md was diffed against ruleset.xml. No quality gate was run; this is a documentation-only change for manual review.

@pekral
pekral marked this pull request as ready for review November 12, 2026 08:32
@pekral
pekral merged commit 06e0dea into master Nov 12, 2026
2 checks passed
@pekral
pekral deleted the docs/readme-standard branch November 12, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant