feat(tooling): add Claude Code skill for adding release notes#3335
Conversation
Adds a project-scoped Claude Code skill (`add-release-notes`) to automatically generate standardized release notes from issue or PR context.
📝 WalkthroughWalkthroughAdds a new Claude skill definition file at ChangesRelease Notes Skill
Estimated code review effort: 1 (Trivial) | ~5 minutes Related IssuesNone found. Related PRsNone found. Suggested labels: documentation Suggested reviewers: None identified. Poem A skill is born, a template neat, 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.claude/skills/add-release-notes/SKILL.md (1)
9-31: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd a non-bugfix release-note path.
This template only fits corrective changes. For feature-only or refactor PRs, it will force the model into a fake "problem → fix" framing and produce misleading notes.
Suggested adjustment
- > Before this update, <X problem> caused <Y situation> [OPTIONAL: under the following <Z conditions>]. With this update, <fix> resolves the issue [OPTIONAL: and <agent> can <perform operation> successfully]. + > Before this update, <X problem> caused <Y situation> [OPTIONAL: under the following <Z conditions>]. With this update, <fix> resolves the issue [OPTIONAL: and <agent> can <perform operation> successfully]. + > For feature or refactor changes, describe the new capability or improvement directly instead of forcing a defect/fix narrative.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.claude/skills/add-release-notes/SKILL.md around lines 9 - 31, The release-note template in the skill instructions is too bug-fix oriented and forces a fake problem/fix narrative for feature or refactor PRs. Update the guidance in the release note skill to add a non-bugfix path, and adjust the Step 1/Step 2 wording in SKILL.md so it can describe feature or refactor changes directly without requiring a “Before this update...” framing; keep the existing template for corrective changes but make the instruction explicitly choose the right format based on the change type.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.claude/skills/add-release-notes/SKILL.md:
- Around line 9-31: The release-note template in the skill instructions is too
bug-fix oriented and forces a fake problem/fix narrative for feature or refactor
PRs. Update the guidance in the release note skill to add a non-bugfix path, and
adjust the Step 1/Step 2 wording in SKILL.md so it can describe feature or
refactor changes directly without requiring a “Before this update...” framing;
keep the existing template for corrective changes but make the instruction
explicitly choose the right format based on the change type.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: e8c5cc3e-404f-4b8d-b14c-8e44fd4ac695
📒 Files selected for processing (1)
.claude/skills/add-release-notes/SKILL.md
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alanconway, vparfonov The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@vparfonov: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Description
This PR adds a project-scoped Claude Code skill to help standardize how we write release notes.
It introduces a
.claude/skills/add-release-notes/SKILL.mdfile that teaches Claude our required release note format and instructs it to automatically extract the necessary context (the problem, situation, and fix) from an issue or PR.How to Use
If you use Claude Code locally, you can now generate a release note for your work by running:
/cc @Clee2691
/assign @jcantrill
Links
Summary by CodeRabbit