Commit 784bc89
docs: document the issue to PR to release workflow in README (#9)
## Summary
Adds a **Contributing & releases** section to the README explaining the
flow introduced in #4:
- Issue → feature branch → PR → squash-merge to `main`.
- Branch-name prefixes and branch-protection rules.
- Conventional Commits enforced on PR titles (via `pr-title` workflow).
- Release-please behavior: rolling release PR, how commit types map to
version bumps, and that merging the release PR triggers `publish.yml` →
npm.
- Links to the workflow files for reference.
No code changes. Docs-only — `docs:` prefix means release-please won't
bump the version or surface this in changelog (intentional:
internal/contributor-facing).
## Test plan
- [ ] Render the README on GitHub and skim for formatting issues
- [ ] Confirm the version-bump table is accurate against
`release-please-config.json`
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>1 parent 1937e0e commit 784bc89
1 file changed
Lines changed: 27 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
154 | 154 | | |
155 | 155 | | |
156 | 156 | | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
157 | 184 | | |
158 | 185 | | |
159 | 186 | | |
0 commit comments