Skip to content

Changelog Protocol

Shared protocol referenced by all agents.

Rule

Important

Update CHANGELOG.md at the end of every task that modifies files. This is not optional. If you made changes, log them.

Location

The changelog lives at the project root: CHANGELOG.md

(Override in project-config.md if different.)

When to Update

Update after any of the following:

  • Creating, moving, renaming, or deleting files or directories
  • Editing source code or documentation
  • Modifying or creating skill files
  • Changing data files or scripts
  • Updating project configuration
  • Any structural reorganization

Do NOT update for: read-only analysis, answering questions, or discussions with no file changes.

Format

Append a new entry under the most recent date header, or create a new date header if the date has changed.

## YYYY-MM-DD --- Short Title

### Category
- Description of change (be specific: file names, what moved where, what was added/removed)

Categories

  • Files Created --- new files or directories
  • Files Moved --- relocated files (state from -> to)
  • Files Renamed --- name changes (state old -> new)
  • Files Deleted --- removed files (state what and why)
  • Content Updated --- significant edits to existing files
  • Skills Updated --- changes to skill files
  • Structure Changed --- directory reorganization

Enforcement

At the end of every task, before presenting results to the user:

  1. Check: "Did I modify any files in this session?"
  2. If yes → read CHANGELOG.md, append a new entry, write it back
  3. If no → skip (no changelog update needed for read-only tasks)