keep-a-changelog-generator
Changelog Generator
Generate changelogs from git history following Keep a Changelog format.
When to Use
Use this skill when you need to:
- Generate changelog entries for a release
- Document changes since the last version
- Create release notes from commits
Changelog Format
Follow 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
Change Categories
Categorize based on commit messages and code changes:
| Category | Commit Keywords | Examples |
|---|---|---|
| Added | add, create, implement, introduce | New features, screens |
| Changed | update, change, modify, refactor, improve | API changes, enhancements |
| Deprecated | deprecate | Features to be removed |
| Removed | remove, delete, drop | Deleted features |
| Fixed | fix, resolve, correct, patch | Bug fixes |
| Security | security, vulnerability, CVE | Security patches |
Git Commands
# 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="2024-01-01" --oneline
Writing Guidelines
User-Facing Descriptions
Translate technical commits to user benefits:
- Technical: "Refactor auth state machine"
- User-facing: "Improved reliability of authentication state management"
Breaking Changes
Flag API changes clearly:
### Changed
- **BREAKING**: `login()` now returns `Promise<User>` instead of `Promise<void>`
Output Example
## [1.2.0] - 2024-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
Workflow
- Run
git logto get commits since last release - Group commits by category (Added/Changed/Fixed/etc.)
- Identify breaking changes
- Write user-facing descriptions
- Include PR/issue references where available
- Format following Keep a Changelog structure
More from stanfordspezi/spezivibe
fhir-data-model-design
Design a FHIR R4 data model for a healthcare application by mapping clinical concepts to resources, terminology, and implementation-ready relationships.
69digital-health-ux-planning
Plan user journeys, onboarding flows, engagement strategies, and day-to-day workflows for digital health products.
58digital-health-compliance-planning
Plan healthcare privacy, research, and regulatory compliance for a digital health product, including HIPAA, IRB, FDA, GDPR, governance, and operational controls.
55biodesign-needs-finding
Guide a user through Stanford Biodesign's needs-finding process to define, scope, and refine a rigorous health-app need statement without jumping prematurely to solutions.
53spezi-platform-selection
Ask about an app's requirements, explain the tradeoff between the React Native Template App and the Spezi Template Application for Apple Platforms, clone the right repository, and hand off to the cloned project's local skills and instructions.
53release-notes-generator
Create release notes that summarize features, fixes, and migration guidance for software releases.
53