Skip to content

docs: add CONTRIBUTING.md + PR template (+ install laravel/pint)#26

Open
zachiler wants to merge 1 commit into
devfrom
feature/contributing-docs
Open

docs: add CONTRIBUTING.md + PR template (+ install laravel/pint)#26
zachiler wants to merge 1 commit into
devfrom
feature/contributing-docs

Conversation

@zachiler
Copy link
Copy Markdown
Member

@zachiler zachiler commented Jun 8, 2026

Summary

Adds the contributor-facing surfaces wireflow was missing — the "branch off dev" rule previously lived only in the internal CLAUDE.md, so external contributors (#22, #19) all opened against main.

  • CONTRIBUTING.md — leads with "open PRs against dev, not main", plus branch model, setup, required tests, code style, and a pre-PR checklist.
  • .github/PULL_REQUEST_TEMPLATE.md — summary / test plan / checklist, with a base-branch reminder.
  • laravel/pint added to require-dev (v1.29.1) so the vendor/bin/pint workflow the CLAUDE.md documents actually works (it wasn't installed).

Companion PR in alpineflow adds the matching docs there.

Test plan

  • vendor/bin/pint --version → 1.29.1; vendor/bin/pint --dirty passes
  • vendor/bin/pest --compact — 205 pass (unchanged)

Contributor-facing guidance (the branching rules previously lived only in the
internal CLAUDE.md): PR against dev not main, branch model, setup, tests, code
style, and a pre-PR checklist. Adds a PR template that reminds contributors to
target dev. Installs laravel/pint as a dev dependency so the documented
`vendor/bin/pint` format workflow actually works.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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