Skip to content

Commit fd15e6d

Browse files
authored
chore: enhance release note command with grouping and context (#4795)
1 parent 54216ff commit fd15e6d

1 file changed

Lines changed: 27 additions & 7 deletions

File tree

.claude/commands/improve-release-note.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,19 @@ You are an assistant that helps improve and format GitHub release notes for the
2121
- If given a release URL, extract the version and fetch the corresponding release
2222
- Use the `gh` command to get release information: `gh release view [version] --repo lablup/backend.ai-webui`
2323

24-
### Step 2: Format According to Guidelines
25-
Follow the strict markdown format that categorizes changes by type:
24+
### Step 2: Analyze and Group Related Changes
25+
Before formatting, analyze the PRs to understand their purpose:
26+
- Review PR descriptions and linked Jira issues for context
27+
- Use `gh pr view [PR_NUMBER] --repo lablup/backend.ai-webui --json title,body,labels` to get detailed information
28+
- Group related changes within each category based on their purpose and impact
29+
- Check Jira issues when needed for additional context
30+
31+
### Step 3: Format According to Guidelines
32+
Follow the markdown format that categorizes and groups changes:
2633

2734
**Categories with emojis:**
2835
- ✨ Features (`feat`)
29-
- 🐛 Bug Fixes (`fix`)
36+
- 🐛 Bug Fixes (`fix`)
3037
- 🔨 Refactoring (`refactor`)
3138
- 🛠 Chores (`chore`)
3239
- 🌐 i18n (`i18n`)
@@ -38,23 +45,36 @@ Follow the strict markdown format that categorizes changes by type:
3845
- ⚡ Performance (`perf`)
3946
- 🔧 Miscellaneous (`misc`)
4047

41-
**Each item must:**
42-
- Be grouped under the correct category based on its prefix or content
48+
**Formatting requirements:**
49+
- **Group related items** within each category (e.g., "AI & Development", "File Management")
50+
- **Add contextual descriptions** (1-2 sentences) for each group explaining the changes and their impact
4351
- Show the FR issue number in bold (e.g., **FR-1002**) when available
4452
- Preserve the contributor info with `by @username`
4553
- Include the PR link in markdown inline format (e.g., [#1234](https://...))
4654
- Keep grouped PRs in a single line with all PRs inline, not multiline
4755
- Display version change in the title, e.g., `# What's Changed (v25.10.1 → v25.11.0)`
4856
- Always output in **English**
57+
- **Avoid exaggerated claims** like "5x faster" or "60% reduction" - use factual, professional language
4958
- Wrap the full output in triple backticks (```) for easy copy-paste
5059

51-
### Step 3: Show Preview and Confirm
60+
**Example format:**
61+
```markdown
62+
## ✨ Features
63+
64+
### AI & Development Experience Enhancements
65+
Enhanced integration with Claude Code and AI development tools. Added Backend.AI platform documentation skill for Claude Code and upgraded AI SDK to v5 with improved message handling.
66+
67+
- **FR-1697**: add a claude skill references the backend.ai docs by @nowgnuesLee in [#4669](...)
68+
- **FR-1463**: upgrade AI SDK to v5 by @agatha197 in [#4697](...)
69+
```
70+
71+
### Step 4: Show Preview and Confirm
5272
1. Display the improved release note format
5373
2. Ask for user confirmation before updating
5474
3. Wait for explicit approval (y/yes/confirm) before proceeding
5575
4. Only update the GitHub release after confirmation
5676

57-
### Step 4: Update Release (After Confirmation)
77+
### Step 5: Update Release (After Confirmation)
5878
Use the `gh` command to update the release:
5979
```bash
6080
gh release edit [version] --notes-file /tmp/improved-release-notes.md --repo lablup/backend.ai-webui

0 commit comments

Comments
 (0)