Skip to content

Commit 72ef3dc

Browse files
emcdclaude
andcommitted
Improve write-release-notes command with refined filters and git operations.
Enhance filtering criteria to focus on user-facing changes that affect how users interact with the tool. Add exclusions for dependency changes and internal restructuring that preserve public APIs. Include git operations to automatically commit generated fragments. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9449542 commit 72ef3dc

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

template/.auxiliary/configuration/claude/commands/write-release-notes.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,24 @@ conventions detailed in `documentation/common/releases.rst`.
3131

3232
### Phase 2: Filtering and Classification
3333

34-
4. **Filter User-Facing Changes**: Focus on changes that affect users:
35-
- CLI or API changes
36-
- Application/library behavior changes
34+
4. **Filter User-Facing Changes**: Focus on changes that affect how users interact with the tool:
35+
- CLI command changes (new options, arguments, output formats)
36+
- API changes (public functions, classes, return values)
37+
- Behavior changes (different responses, error messages, processing)
38+
- Configuration changes (new settings, file formats)
3739
- Deprecations and removals
38-
- Platform support changes (Python versions, etc.)
40+
- Platform support changes (Python versions, OS support)
3941

4042
**Exclude** internal changes:
4143
- GitHub workflows
42-
- `pyproject.toml` modifications
44+
- Dependency changes without API impact
45+
- Internal module restructuring that preserves public API
4346
- Git ignore files
4447
- Modules in internals subpackages (`__`)
45-
- Internal refactoring without user impact
48+
- Version bumps and maintenance updates
49+
- Internal refactoring without user-visible changes
50+
51+
**Key Test**: Ask "Does this change how a user invokes the tool, what options they have, or what behavior they observe?"
4652

4753
5. **Classify Changes**: Determine appropriate type for each change:
4854
- `enhance`: features and improvements
@@ -72,10 +78,14 @@ conventions detailed in `documentation/common/releases.rst`.
7278
- Be understandable by users, not just developers
7379
- Include topic prefixes when appropriate (e.g., "CLI: ", "API: ")
7480

75-
### Phase 4: Final Review
81+
### Phase 4: Final Review and Commit
7682

7783
9. **Summary**: Provide a brief summary of fragments created and any notable patterns or changes identified
7884

85+
10. **Commit Changes**: Add fragments to git and commit them:
86+
- `git add .auxiliary/data/towncrier`
87+
- `git commit -m "Add news fragments for upcoming release"`
88+
7989
## Additional Instructions
8090

8191
- Read full commit messages for context; only examine diff summaries if commit messages are unclear

0 commit comments

Comments
 (0)