Skip to content

Rewrite README.md as a developer/contributor landing page#1029

Merged
kraftbj merged 1 commit into
trunkfrom
update-readme
Apr 7, 2026
Merged

Rewrite README.md as a developer/contributor landing page#1029
kraftbj merged 1 commit into
trunkfrom
update-readme

Conversation

@kraftbj
Copy link
Copy Markdown
Contributor

@kraftbj kraftbj commented Apr 7, 2026

Summary

  • Replaces the bare-stub README with a contributor-focused landing page
  • Adds badges (WordPress.org version, license, PHP version, CI status)
  • Documents project structure, development setup, testing/linting commands, and contributing workflow (branching, changelog entries, CI expectations)
  • Keeps security and license sections

Test plan

  • Verify badges render correctly on the GitHub PR/branch preview
  • Confirm all external links resolve (WordPress.org plugin page, wiki, translations, HackerOne)
  • Confirm CI status badge points to the correct workflow

The previous README was a bare stub with mostly empty sections. This
replaces it with a proper contributor-focused page covering project
structure, development setup, testing/linting commands, contributing
workflow, and changelog entry requirements.
@kraftbj kraftbj merged commit 2a7c8b1 into trunk Apr 7, 2026
6 checks passed
@kraftbj kraftbj deleted the update-readme branch April 7, 2026 22:28
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