Add To Streamlined

Streamline the process of adding new entries to project changelogs, maintaining consistent formatting, version sequencing, and categorization across releases.

When to Use This Command

Run this command when...

• You have completed a feature, bugfix, or change that needs to be recorded in the CHANGELOG.md
• A new version is being released and you need to add the corresponding changelog entry with proper formatting
• You want to maintain Keep a Changelog format consistently without manually editing the file
• Multiple changes need to be categorized (added, changed, fixed, removed, deprecated) in a single entry
• You need to update both the changelog and version files (package.json, setup.py) in sync

Quick Start

Copy
# .claude/commands/add-to-streamlined.md
---
name: Add To Streamlined
description: Add entries to CHANGELOG.md with consistent formatting
command: true
---
Add to changelog: $ARGUMENTS

Parse version and change type from arguments.
Add entry to CHANGELOG.md following Keep a Changelog format.
Update version references in project files if needed.

Copy
# Invoke the command
claude "/add-to-streamlined 1.2.0 added 'User avatar upload with S3 integration'"

# Expected output
# > Reading current CHANGELOG.md...
# > Adding entry:
# >   Version: 1.2.0
# >   Date: 2026-03-15
# >   Type: Added
# >   Entry: User avatar upload with S3 integration
# > Updated CHANGELOG.md:
# >   ## [1.2.0] - 2026-03-15
# >   ### Added
# >   - User avatar upload with S3 integration
# > Also updated: package.json version to 1.2.0

Core Concepts

Concept	Description
Format Compliance	Follows Keep a Changelog specification for consistent, parseable changelogs
Version Ordering	Inserts new entries at the top with correct chronological and semver ordering
Category Support	Supports Added, Changed, Deprecated, Removed, Fixed, and Security categories
Version Sync	Optionally updates version numbers in package.json, setup.py, or other version files
Unreleased Section	Maintains an Unreleased section for changes not yet tagged with a version

Changelog Entry Structure
==========================

  ## [Unreleased]
  (accumulated changes pending release)

  ## [1.2.0] - 2026-03-15     <-- New entry added here
  ### Added
  - User avatar upload with S3 integration

  ## [1.1.0] - 2026-03-01
  ### Fixed
  - Login timeout on slow connections

  ## [1.0.0] - 2026-02-15
  ### Added
  - Initial release

Configuration

Parameter	Description	Default	Example	Required
$ARGUMENTS	Version, change type, and description	none	"1.2.0 fixed 'Login bug'"	Yes
changelog_path	Path to the changelog file	CHANGELOG.md	"docs/CHANGELOG.md"	No
update_version	Also update version in project files	true	false	No
date	Date for the release entry	today	"2026-04-01"	No
unreleased	Add to Unreleased section instead of a version	false	true	No

Best Practices

1. Add changelog entries as you complete work -- Do not wait until release time to write all entries. Add each change as it is merged so details are fresh and accurate.

2. Use correct change categories -- "Added" for new features, "Fixed" for bugfixes, "Changed" for modifications to existing features, "Removed" for deleted functionality, "Security" for vulnerability patches.

3. Write user-facing descriptions -- Changelog entries should describe what changed from the user perspective, not internal implementation details. "Added CSV export to reports" instead of "Added CsvWriter class."

4. Keep an Unreleased section -- Accumulate changes under Unreleased during development, then move them to a versioned section at release time with --promote-unreleased.

5. Sync version numbers across files -- Keep update_version: true to ensure package.json, setup.py, and other version references stay consistent with the changelog.

Common Issues

Duplicate version entries: Adding the same version number twice creates a malformed changelog. The command checks for existing versions and appends to the existing section or warns about duplicates.

Incorrect semver ordering: Changelog entries must be in descending version order. If a patch version is added after a minor version entry, the command reorders automatically.

Missing CHANGELOG.md file: If no changelog exists, the command creates one with the standard Keep a Changelog header and the first entry. Verify the format matches your project conventions.