Skip to content

Add README and CONTRIBUTING documentation - #4

Merged
tyrsson merged 2 commits into
0.1.xfrom
docs/readme-contributing
Aug 18, 2026
Merged

Add README and CONTRIBUTING documentation#4
tyrsson merged 2 commits into
0.1.xfrom
docs/readme-contributing

Conversation

@tyrsson

@tyrsson tyrsson commented Aug 18, 2026

Copy link
Copy Markdown
Member

Summary

Adds README.md and CONTRIBUTING.md, mirroring webware-mailer's structure with message-specific content.

Changes

  • README.md: package description, quick start (composer install, middleware registration, sending + hops semantics, view helper rendering), badges.
  • Badges: PHP version, latest version, license, CI, Codecov, and mutation (Stryker) — the mutation badge endpoint is wired to the 0.1.x branch and may not resolve until the Stryker dashboard works; noted separately.
  • CONTRIBUTING.md: issue/PR guidance, local checks (composer scripts + mago), test conventions (PHPUnit 13 coverage metadata, mock/stub rules), coding standards.

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tyrsson
tyrsson merged commit 39c05da into 0.1.x Aug 18, 2026
11 checks passed
@tyrsson
tyrsson deleted the docs/readme-contributing branch August 18, 2026 01:34
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