34 lines
873 B
Markdown
34 lines
873 B
Markdown
|
# SPEC: Changelog and Release Notes Process
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
There's no changelog or release note process. Completed tasks produce a VERDICT.md but there's no aggregate record of what changed. This makes it hard to generate release notes or see the project's history at a glance.
|
||
|
|
|
||
|
|
## Changes
|
||
|
|
|
||
|
|
### 1. `CHANGELOG.md` at `~/.automaton/`
|
||
|
|
|
||
|
|
Root-level changelog file with entries appended on task completion:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
# Changelog
|
||
|
|
|
||
|
|
## [unreleased]
|
||
|
|
|
||
|
|
### Added
|
||
|
|
- description (#task-name)
|
||
|
|
|
||
|
|
### Fixed
|
||
|
|
- description (#task-name)
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2. Update `.rules.md`
|
||
|
|
|
||
|
|
Add a rule: "When a task reaches Resolution (VERDICT.md written), append an entry to CHANGELOG.md."
|
||
|
|
|
||
|
|
## Acceptance Criteria
|
||
|
|
|
||
|
|
- [ ] `~/.automaton/CHANGELOG.md` exists with [unreleased] header
|
||
|
|
- [ ] `.rules.md` mentions changelog updates as part of task completion
|
||
|
|
- [ ] Format is clean enough to use as release notes source
|