Back to list
rust-works

changelog

by rust-works

1🍴 0📅 Jan 7, 2026

SKILL.md


name: changelog description: Manages CHANGELOG.md entries following Keep a Changelog format. Use when adding changelog entries, documenting changes, updating release notes, or preparing for a release. Triggers on terms like "changelog", "document changes", "release notes", "what changed".

Changelog Management Skill

This skill helps maintain CHANGELOG.md following Keep a Changelog format.

Changelog Structure

# 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [X.Y.Z] - YYYY-MM-DD

### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security

[Unreleased]: https://github.com/rust-works/omni-dev/compare/vX.Y.Z...HEAD
[X.Y.Z]: https://github.com/rust-works/omni-dev/compare/vX.Y.Z-1...vX.Y.Z

Categories

CategoryUse For
AddedNew features
ChangedChanges in existing functionality
DeprecatedSoon-to-be removed features
RemovedNow removed features
FixedBug fixes
SecurityVulnerability fixes
DocumentationDocumentation-only changes
RefactoredCode changes that don't affect behavior

Entry Format

Each entry should:

  • Start with **Bold Feature Name**: followed by description
  • Use sub-bullets for implementation details
  • Be written in past tense for releases, present for unreleased

Good Example

### Added
- **Commit Message Validation Command**: New `check` command for validating commit messages
  - AI-powered analysis with configurable severity levels
  - Multiple output formats (text, JSON, YAML) for CI/CD integration
  - Smart exit codes for pipeline integration

Bad Example

### Added
- Added check command
- It validates commits

Key Learnings

Incremental Updates

Add entries to [Unreleased] as features are merged, not all at once during release. This:

  • Makes release prep faster
  • Ensures nothing is missed
  • Provides better commit-to-changelog traceability

Always maintain comparison links at the bottom of the file:

[Unreleased]: https://github.com/rust-works/omni-dev/compare/vX.Y.Z...HEAD
[X.Y.Z]: https://github.com/rust-works/omni-dev/compare/vX.Y.Z-1...vX.Y.Z

When releasing:

  1. Update [Unreleased] link to compare against new version
  2. Add new version's comparison link

Gathering Changes

To see what changed since last release:

# Get last release tag
git describe --tags --abbrev=0

# Show commits since last release
git log --oneline $(git describe --tags --abbrev=0)..HEAD

# Show detailed commit info
git show <commit-hash> --stat

Instructions

  1. Read current CHANGELOG.md
  2. Identify the appropriate category for changes
  3. Write clear, descriptive entries with details
  4. For releases, move [Unreleased] content to new version section
  5. Update version comparison links

Score

Total Score

65/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新

+5
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon