Skip to content

Commit df1bcb1

Browse files
committed
docs: clarify plugin version bump conventions with semver guidelines
Add semver level guidance (patch/minor/major) and once-per-branch rule to avoid redundant bumps while ensuring the bump level matches the scope of accumulated changes. Assisted-by: Claude:claude-opus-4-6
1 parent fbd4bea commit df1bcb1

2 files changed

Lines changed: 15 additions & 6 deletions

File tree

CLAUDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,15 @@ structure.
4444

4545
- Use kebab-case for all names
4646
- Use `${CLAUDE_PLUGIN_ROOT}` for portable paths in hooks/MCP configs
47-
- When editing plugin files (other than README.md or CLAUDE.md), bump the version in that plugin's `.claude-plugin/plugin.json`
47+
- When editing plugin files (other than README.md or CLAUDE.md), bump the version in
48+
that plugin's `.claude-plugin/plugin.json` following semver:
49+
- **patch**: bug fixes, typo corrections, minor wording changes
50+
- **minor**: new skills, commands, hooks, agents, or backward-compatible behavior changes
51+
- **major**: breaking changes (renamed/removed skills, changed hook behavior, restructured plugin)
52+
- Only bump once per PR branch. Before bumping, check `git diff main -- <plugin>/.claude-plugin/plugin.json`
53+
to see if the version was already bumped. Skip if it was, unless the accumulated
54+
changes now warrant a higher semver level (e.g., patch already bumped but a new
55+
skill was added — upgrade to minor)
4856
- Use plugin-dev skills: `/plugin-dev:create-plugin`, `/plugin-dev:skill-reviewer`, `/plugin-dev:plugin-validator`
4957

5058
## Documentation

pr-review-toolkit/skills/review-pr/SKILL.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,23 +170,23 @@ only when line is present.
170170
171171
1. `{file}[:{line}]` -- **{title}**
172172
{description}
173-
_Verified: {verificationRationale}_
173+
{if verificationStatus = "verified"}_Verified: {verificationRationale}_{end if}
174174
175175
### Important Issues
176176
177177
{for each finding where status = "new" and effective severity = important}
178178
179179
2. `{file}[:{line}]` -- **{title}**
180180
{description}
181-
_Verified: {verificationRationale}_
181+
{if verificationStatus = "verified"}_Verified: {verificationRationale}_{end if}
182182
183183
### Suggestions
184184
185185
{for each finding where status = "new" and effective severity = suggestion}
186186
187187
3. `{file}[:{line}]` -- **{title}**
188188
{description}
189-
_Verified: {verificationRationale}_
189+
{if verificationStatus = "verified"}_Verified: {verificationRationale}_{end if}
190190
191191
### Partial Overlaps
192192
@@ -195,7 +195,7 @@ only when line is present.
195195
4. `{file}[:{line}]` -- **{title}**
196196
Extends existing review comment: {existingCoverage}.
197197
New insight: {delta}.
198-
_Verified: {verificationRationale}_
198+
{if verificationStatus = "verified"}_Verified: {verificationRationale}_{end if}
199199
200200
### Strengths
201201
@@ -224,7 +224,8 @@ Key formatting rules:
224224
- **No `[severity/confidence]` tags** — severity is conveyed by section
225225
header; confidence is implicit (low-confidence findings were filtered
226226
during analysis; false positives were removed by verification)
227-
- **Verification line in italics** per finding — shows what was checked
227+
- **Verification line in italics** only for verified findings — omit
228+
entirely when `verificationStatus` is `unverified`
228229
- **Only actionable findings are numbered** — Strengths and Previous
229230
Review Status are informational only
230231
- **Duplicates omitted** — if any, add a one-line note: "N findings

0 commit comments

Comments
 (0)