Skip to content

docs: add CONTRIBUTING.md + PR template#29

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

docs: add CONTRIBUTING.md + PR template#29
zachiler wants to merge 1 commit into
devfrom
feature/contributing-docs

Conversation

@zachiler

@zachiler zachiler commented Jun 8, 2026

Copy link
Copy Markdown
Member

Summary

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

  • CONTRIBUTING.md — leads with "open PRs against dev, not main", plus branch model, setup, required tests, the build/dist commit step, conventions, and a pre-PR checklist.
  • .github/PULL_REQUEST_TEMPLATE.md — summary / test plan / checklist, with a base-branch reminder.

Companion PR in wireflow adds the matching docs (and installs pint there).

Test plan

  • Docs only — no code/test impact.

Contributor-facing guidance (the branching rules previously lived only in the
internal CLAUDE.md): PR against dev not main, branch model, setup, tests, the
build/dist step, conventions, and a pre-PR checklist. Adds a PR template that
reminds contributors to target dev.

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