Skip to content

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

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

Shrnutí

README je sjednocené podle společného standardu z github-readme-generator. Jde jen o dokumentaci. README se zkrátilo z ~250 na 132 řádků.

  • Pořadí: Requirements → Installation → Configuration → Quick start → What it does → Documentation → Testing → Upgrading → Changelog → Contributing → Security → Credits → License; bez horizontálních oddělovačů.
  • Quick start ukazuje vendor/bin/rector process --dry-run a hned u rector process je varování, že přepisuje soubory.
  • Opravena verze rector/rector v Requirements z ^2.8.1 na ^2.8.4 podle composer.json.
  • Badges převedené z poser.pugx na shields.io flat-square: verze, licence, CI (Checks, push na master), downloads.
  • Nové docs/configuration.md (styly konfigurace, skip pravidla, kombinace se sadami vč. Laravelu, parallel timeout) a docs/rule-set.md (kurátorský model, proč pravidlo chybí, co balíček instaluje).
  • .github/CONTRIBUTING.md převzal tabulku vývojových příkazů a odstavec o CI, ověřený proti pr.yml.
  • Odstraněno nepravdivé tvrzení, že composer require stáhne „přesně pět souborů“ – git archive obsahuje i AGENTS.md, .agents/ a .codex/.

Zjištění mimo rozsah (neopraveno)

  • GitHub About uvádí „228 hand-picked rules“, skutečný počet je 216 (rules/rules.php, composer.json).
  • Nové docs/ se dostane do Composer distribuce; pokud to není žádoucí, je potřeba /docs export-ignore v .gitattributes.
  • scripts.build začíná composer check fix – nejspíš překlep za composer fix.
  • Krok „lint shipped sources“ v CI lintuje jen rules/rules.php, ne rector.php.
  • composer.lock je v .gitignore, ale cache klíč CI hashuje composer.lock.

Ověření

Relativní odkazy a kotvy ve čtyřech upravených souborech ověřeny skriptem, badges odpovídají 200. Počty pravidel v tabulce oblastí (součet 216) ověřeny proti rules/rules.php. composer check neběžel – quality gate běží podle AGENTS.md před mergem.

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Nov 12, 2026
@pekral
pekral marked this pull request as ready for review November 12, 2026 09:04
@pekral
pekral merged commit 8fa3355 into master Nov 12, 2026
3 checks passed
@pekral
pekral deleted the docs/readme-standard branch November 12, 2026 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant