agentleFS
peopleforresterpeopleforrester/claude-dotfiles/skills/git/changelog/SKILL.md

changelog

Skill3 starsChanged 7 months agoMITView on GitHub

Generate changelog entries following Keep a Changelog format

We split this skill into the rules it gives an agent

7 rules. 0 are common, 7 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 141 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create changelog entries following Keep a Changelog format.

    line 8
  2. Distinctive:

    Write for users, not developers

    line 111
  3. Distinctive:

    Use technical jargon without explanation

    line 121
  4. Distinctive:

    If using conventional commits:

    line 159
  5. Distinctive:

    When to bump versions:

    line 180
  6. Distinctive:

    Update changelog with every PR (in Unreleased)

    line 190
  7. Distinctive:

    Consider audience: users vs developers

    line 194

“Common” is measured: kept by at least 6 in 10 of the 141 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

/changelog - Generate Changelog Entry

Create changelog entries following Keep a Changelog format.

Usage

/changelog                    # Generate entry for recent changes
/changelog v1.2.0             # Generate entry for specific version
/changelog --unreleased       # Add to Unreleased section

Process

1. Analyze Changes

Review commits since last release:

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

# List commits since last tag
git log v1.1.0..HEAD --oneline

# Or list commits since date
git log --since="2024-01-01" --oneline

2. Categorize Changes

Group changes into categories:

CategoryDescription
AddedNew features
ChangedChanges in existing functionality
DeprecatedSoon-to-be removed features
RemovedRemoved features
FixedBug fixes
SecuritySecurity vulnerability fixes

3. Generate Entry

Format following Keep a Changelog:

## [1.2.0] - 2026-01-28

### Added
- User authentication with OAuth support (#123)
- Dark mode theme option (#145)
- Export data to CSV functionality

### Changed
- Improved dashboard loading performance by 40%
- Updated dependencies to latest versions

### Fixed
- Cart total calculation rounding error (#156)
- Mobile navigation menu not closing (#162)

### Security
- Patched XSS vulnerability in comment field

[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0

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

## [Unreleased]

### Added
- [New feature in development]

## [1.2.0] - 2026-01-28

### Added
- Feature X

### Fixed
- Bug Y

## [1.1.0] - 2026-01-15

### Added
- Feature Z

[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/user/repo/compare/v1.0.0...v1.1.0

Writing Good Entries

Do

  • Write for users, not developers
  • Be specific about what changed
  • Include issue/PR numbers for reference
  • Group related changes together
  • Highlight breaking changes prominently

Don't

  • Include internal refactoring details
  • List every commit
  • Use technical jargon without explanation
  • Forget to update version links

Examples

Good Entries

### Added
- Email notifications for order status changes (#234)
- Support for multiple payment methods including Apple Pay

### Changed
- Dashboard now loads 3x faster due to lazy loading
- Minimum password length increased to 12 characters

### Fixed
- Users no longer logged out after password reset (#267)
- PDF export now includes all table columns (#271)

### Security
- Fixed SQL injection vulnerability in search (CVE-2026-1234)

Bad Entries

### Changed
- Updated code
- Fixed stuff
- Refactored components
- Merged PR #123

Automation

From Git Commits

If using conventional commits:

# Generate from conventional commits
git log v1.1.0..HEAD --pretty=format:"%s" | \
  grep -E "^(feat|fix|docs|style|refactor|perf|test|chore):" | \
  sort

With Release Tools

# Using standard-version
npx standard-version

# Using release-please
# Configured via GitHub Actions

Semantic Versioning Reference

When to bump versions:

Change TypeVersion BumpExample
Breaking changesMajor (X.0.0)1.0.0 → 2.0.0
New featuresMinor (0.X.0)1.0.0 → 1.1.0
Bug fixesPatch (0.0.X)1.0.0 → 1.0.1

Tips

  • Update changelog with every PR (in Unreleased)
  • Convert Unreleased to version on release
  • Keep entries user-focused
  • Link to full diff at bottom of file
  • Consider audience: users vs developers

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.