# Changelog

> Guidelines for maintaining changelogs based on Keep a Changelog format. Trigger: When writing or updating CHANGELOG.md files.

- Skill: `odjaramillo/changelog` (Agent Skill)
- Install (CLI): `npx skillmds@latest add odjaramillo/changelog`
- Raw SKILL.md: https://api.skillmd.com/api/skills/odjaramillo/changelog/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- License: Apache-2.0
- Author: odjaramillo (https://skillmd.com/u/odjaramillo)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/odjaramillo/changelog

---


## Critical Patterns

### Structure (REQUIRED)

```markdown
# Changelog

All notable changes will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

### Added

- New features

### Changed

- Changes to existing functionality

### Fixed

- Bug fixes

## [1.2.0] - 2024-01-15

### Added

- Multi-language support ([#123](link))
```

### Change Types (REQUIRED)

```
Added      → New features, endpoints, options
Changed    → Changes to existing functionality
Deprecated → Features planned for removal
Removed    → Deleted features
Fixed      → Bug fixes
Security   → Vulnerability patches
```

---

## Decision Tree

```
New feature?               → Added
Behavior change?           → Changed
Bug fix?                   → Fixed
Security patch?            → Security
Will be removed?           → Deprecated
Already removed?           → Removed
```

---

## Code Examples

### Good Entry

```markdown
### Added

- Email notifications for order status changes with customizable templates
- Batch processing support for up to 1000 items per request

### Fixed

- Race condition in payment processing that could cause duplicate charges
- Memory leak when uploading files larger than 100MB
```

### Bad Entry

```markdown
### Added

- New feature (too vague)
- Updated stuff (unclear)

### Fixed

- Fixed bug (which bug?)
```

---

## Best Practices

- Update changelog with every PR
- Write from the user's perspective
- Include issue/PR numbers for reference
- Date entries in ISO format (YYYY-MM-DD)
- Keep unreleased changes at the top