Skip to content

docs: add CONTRIBUTING.md referenced by the README - #229

Merged
morcen merged 1 commit into
mainfrom
fix/issue-140-add-contributing-guide
Sep 7, 2026
Merged

docs: add CONTRIBUTING.md referenced by the README#229
morcen merged 1 commit into
mainfrom
fix/issue-140-add-contributing-guide

Conversation

@morcen

@morcen morcen commented Sep 6, 2026

Copy link
Copy Markdown
Owner

What was broken

README.md's "Contributing" section links to CONTRIBUTING.md:

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

but no CONTRIBUTING.md file existed anywhere in the repository (only CHANGELOG.md, LICENSE.md, README.md, and UPGRADE.md exist at the repo root), so the link 404'd on GitHub.

What changed

Added CONTRIBUTING.md at the repo root, covering:

  • Where to report bugs/feature requests (pointing at the existing issue templates)
  • Branch/PR expectations (branch from main, add tests, one PR per feature)
  • Code style, via the existing composer format (Pint) script
  • Running the test suite, via the existing composer test (Pest) script
  • Supported PHP/Laravel versions, matching the README's "Requirements" section

No application code was touched, so no test changes were needed; the full existing test suite (composer test) still passes (250 passed).

Fixes #140

🤖 Generated with Claude Code

https://claude.ai/code/session_01Ab6eHRcjUdPBDFx2ZNZDhs


Generated by Claude Code

README.md's Contributing section links to CONTRIBUTING.md, but the
file did not exist anywhere in the repository, so the link 404'd on
GitHub. Add a short contributing guide covering branch/PR expectations,
code style (composer format / Pint), and running the test suite
(composer test), consistent with the scripts already defined in
composer.json.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ab6eHRcjUdPBDFx2ZNZDhs
@morcen
morcen merged commit 5a282ee into main Sep 7, 2026
18 checks passed
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.

README references CONTRIBUTING.md, which doesn't exist in the repo

1 participant