Skip to content

Commit b15112f

Browse files
sgwannabeclaude
andcommitted
docs: apply PR #82 review feedback (gemini)
- CONTRIBUTING.md: update verify-plugin.sh check count from 34 to 57 (actual current count; was already 45 in v1.3.0 per CHANGELOG line 253) - CONTRIBUTING.md: align agent count in PR checklist with verify-plugin.sh (143 -> 144, matches scripts/verify-plugin.sh line 49) - CONTRIBUTING.md: rewrite "Release process" section to describe the release-please automated flow (replaces the contradictory manual tag/bump steps that conflicted with the new commit-message convention introduced earlier in this same file) - CONTRIBUTING.md: PR checklist now points contributors at the hand-maintained plugins/preview-forge/CHANGELOG.md and warns against hand-editing the release-please-managed root CHANGELOG.md / manifests Refs PR #82 review comments Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent eeba3c5 commit b15112f

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ for the major bump.
4949
```bash
5050
git clone https://github.com/Two-Weeks-Team/PreviewForgeForClaudeCode
5151
cd PreviewForgeForClaudeCode
52-
bash scripts/verify-plugin.sh # 34 checks
52+
bash scripts/verify-plugin.sh # 57 checks (Pass: 57 / Fail: 0)
5353
```
5454

5555
Install the plugin under development locally:
@@ -118,13 +118,16 @@ fix the code, not the proposal (or justify the divergence in the PR).
118118

119119
## PR checklist (auto-enforced by CI)
120120

121-
- [ ] `bash scripts/verify-plugin.sh` passes (all 34 checks)
122-
- [ ] Agent count still 143, or CHANGELOG + proposal updated explicitly
121+
- [ ] `bash scripts/verify-plugin.sh` passes (all 57 checks)
122+
- [ ] Agent count still 144, or CHANGELOG + proposal updated explicitly
123123
- [ ] All agents use `model: opus` (no Sonnet/Haiku mixing)
124124
- [ ] No 3rd-party service dependencies introduced
125125
- [ ] Layer-0 rules respected (`plugins/preview-forge/methodology/global.md`)
126-
- [ ] Version bumped if release-worthy (both manifests)
127-
- [ ] `CHANGELOG.md` entry
126+
- [ ] Conventional Commit message with **semantic scope** (release-please
127+
autobumps semver — do **not** hand-edit version in manifests or root
128+
`CHANGELOG.md`)
129+
- [ ] `plugins/preview-forge/CHANGELOG.md` entry (the hand-maintained
130+
plugin changelog; root `CHANGELOG.md` is release-please generated)
128131

129132
## Code of conduct
130133

@@ -134,13 +137,25 @@ should treat each other as collaborators, not as Devil's Advocates.
134137

135138
## Release process
136139

137-
1. PR merged to `main`
138-
2. `version` bumped in both `.claude-plugin/marketplace.json` and
139-
`plugins/preview-forge/.claude-plugin/plugin.json`
140-
3. `CHANGELOG.md` entry added under `## [X.Y.Z]`
141-
4. `git tag vX.Y.Z && git push origin vX.Y.Z`
142-
5. GitHub Actions `release.yml` automatically creates the GitHub Release
143-
with notes extracted from CHANGELOG
140+
Releases are automated via **release-please**. Contributors do **not**
141+
hand-bump versions or hand-tag releases.
142+
143+
1. PR with Conventional Commit messages (semantic scope) merges to `main`.
144+
2. release-please opens / updates a `chore(main): release X.Y.Z` PR that
145+
accumulates pending bumps from the commit history.
146+
3. When that release PR is merged, release-please:
147+
- bumps `version` in `.claude-plugin/marketplace.json` and
148+
`plugins/preview-forge/.claude-plugin/plugin.json`,
149+
- regenerates the **root** `CHANGELOG.md`,
150+
- creates the `vX.Y.Z` git tag, and
151+
- publishes the GitHub Release with notes extracted from the changelog.
152+
4. `plugins/preview-forge/CHANGELOG.md` is **hand-maintained** in feature
153+
PRs — add an entry under `## [X.Y.Z]` describing the user-visible
154+
change. release-please does not touch this file.
155+
156+
If your change is release-worthy, the only contributor action is writing
157+
a clean Conventional Commit and updating
158+
`plugins/preview-forge/CHANGELOG.md`.
144159

145160
## Questions
146161

0 commit comments

Comments
 (0)