关于 keep-a-changelog-generator
keep-a-changelog-generator 是一项根据 Git 历史生成和维护结构化变更日志的技能,适用于项目维护者。它按 Keep a Changelog 类别整理变更,并提供面向用户的描述和破坏性变更标记。
主要功能
- 01根据 Git 历史生成条目
- 02按标准类别归纳变更
- 03将提交改写为用户描述
- 04标记破坏性变更
- 05按 CHANGELOG.md 格式输出
适用场景
- 01准备版本发布的变更日志
- 02记录上一版本以来的变更
- 03维护项目的 CHANGELOG.md
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ stanfordspezi/ spezivibe --skill keep-a-changelog-generator安装后在 Claude Code 中输入/keep-a-changelog-generator确认已加载。
详细介绍
更新日志生成器
按照 Keep a Changelog 格式,从 git 历史生成更新日志。
何时使用
当你需要以下操作时,使用此技能:
- 为某个版本生成更新日志条目
- 记录自上一个版本以来的变更
- 维护项目的
CHANGELOG.md文件
当你需要带有亮点、用法示例和迁移指南的叙述式版本公告时,改用 release-notes-generator。此技能维护结构化的 CHANGELOG.md 文件;而那一个则撰写单个版本的故事。
更新日志格式
遵循 Keep a Changelog:
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- New features
### Changed
- Changes in existing functionality
### Deprecated
- Features that will be removed
### Removed
- Removed features
### Fixed
- Bug fixes
### Security
- Security fixes
变更分类
根据提交信息和代码变更进行分类:
| 分类 | 提交关键词 | 示例 |
|---|---|---|
| Added | add, create, implement, introduce | 新功能、界面 |
| Changed | update, change, modify, refactor, improve | API 变更、增强 |
| Deprecated | deprecate | 即将移除的功能 |
| Removed | remove, delete, drop | 已删除的功能 |
| Fixed | fix, resolve, correct, patch | Bug 修复 |
| Security | security, vulnerability, CVE | 安全补丁 |
Git 命令
# Recent commits
git log --oneline -20
# Commits between tags
git log v1.0.0..HEAD --oneline
# Full commit messages
git log --format="%h %s%n%b" HEAD~10..HEAD
# Commits since a date
git log --since="2026-01-01" --oneline
撰写指南
面向用户的描述
将技术性提交转化为用户收益:
- 技术性:"Refactor auth state machine"
- 面向用户:"Improved reliability of authentication state management"
破坏性变更
明确标记 API 变更:
### Changed
- **BREAKING**: `login()` now returns `Promise<User>` instead of `Promise<void>`
输出示例
## [1.2.0] - 2026-01-14
### Added
- New health data visualization screen
- Apple HealthKit integration for step counting
- Export health data to PDF
### Changed
- Improved task scheduling performance
- Updated questionnaire UI design
### Fixed
- Fixed race condition in account state initialization
- Resolved infinite loop when no tasks exist
工作流
- 运行
git log获取自上一个版本以来的提交 - 按分类对提交分组(Added/Changed/Fixed 等)
- 识别破坏性变更
- 撰写面向用户的描述
- 在可用的情况下包含 PR/issue 引用
- 按照 Keep a Changelog 结构进行格式化
评论
支持 Markdown