Skip to content

docs: standardize README, centralize governance#47

Open
jsirish wants to merge 4 commits into
3from
docs/standardize-readme
Open

docs: standardize README, centralize governance#47
jsirish wants to merge 4 commits into
3from
docs/standardize-readme

Conversation

@jsirish

@jsirish jsirish commented Jun 18, 2026

Copy link
Copy Markdown
Member

Standardizes README to canonical template, removes per-repo governance files now centralized in dynamic/.github. Part of the Essentials suite-wide documentation standardization.

Changes

  • Fix docs link from en/5/ to en/6/ in Customization section
  • Update CI badge to canonical actions/workflows/ci.yml URL format
  • Update Sponsors badge to canonical format (drop deprecated GitHub Sponsors badge)
  • Add missing Unstable Version badge to badge block
  • Correct PHP requirement to ^8.3 (was ^8.1 — mismatch with composer.json)
  • Use exact composer.json package names in Requirements (e.g. silverstripe/recipe-cms not SilverStripe)
  • Fix Maintainers URL to https:// and exact canonical format
  • Standardize Bugtracker and Development and Contribution sections to suite-wide boilerplate
  • Simplify License section to See [License](LICENSE.md)
  • Add CHANGELOG.md Keep-a-Changelog stub
  • Remove CONTRIBUTING.md (now centralized in dynamic/.github org defaults)

Closes no specific issue — part of suite-wide docs standardization.

@jsirish

jsirish commented Jun 18, 2026

Copy link
Copy Markdown
Member Author

Preparing review...

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