📝 docs: rename agent changelog for clarity
- Rename CHANGELOG.md to AGENT_CHANGELOG.md - Better reflects purpose as agent contribution tracker - Distinguishes from software changelog files - Update all references in ADR and documentation - Maintain consistency with AGENTS.md naming Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
This file tracks the agent's contributions and decisions. Kept compact and iterative.
|
||||
|
||||
## Current Focus (2026-04-04)
|
||||
## Current Focus (2026-04-05)
|
||||
|
||||
### Active Configuration
|
||||
- **Agent**: DanceLessonsCoachProgrammer
|
||||
@@ -15,6 +15,24 @@ This file tracks the agent's contributions and decisions. Kept compact and itera
|
||||
- ✅ Restrict git commands (no add/commit/push/merge/rebase)
|
||||
- ✅ Require ADR documentation for all architectural decisions
|
||||
|
||||
### Latest Commit (2026-04-05)
|
||||
**Commit:** `b279a31`
|
||||
**Message:** `✨ feat: implement OpenAPI/Swagger documentation with swaggo/swag`
|
||||
|
||||
**Changes:**
|
||||
- Added comprehensive API documentation using swaggo/swag
|
||||
- Embedded OpenAPI spec in binary using go:embed
|
||||
- Added Swagger UI at /swagger/
|
||||
- Documented all endpoints, models, and validation rules
|
||||
- Added go:generate directive for easy regeneration
|
||||
- Updated README, AGENTS, AGENT_CHANGELOG with documentation
|
||||
- Finalized ADR 0013 with implementation details
|
||||
- Gitignored generated docs directory
|
||||
|
||||
**Files Changed:** 12 files, 371 insertions(+), 38 deletions(-)
|
||||
|
||||
**Status:** ✅ Pushed to main branch
|
||||
|
||||
## Workflow Constraints
|
||||
|
||||
### Always Ask Before
|
||||
@@ -29,7 +47,7 @@ This file tracks the agent's contributions and decisions. Kept compact and itera
|
||||
|
||||
### Always Document
|
||||
- New ADRs in `adr/` folder
|
||||
- Feature changes in CHANGELOG.md
|
||||
- Feature changes in AGENT_CHANGELOG.md
|
||||
- Test scenarios in `features/`
|
||||
|
||||
## Agent Session Guide
|
||||
@@ -46,7 +64,7 @@ vibe start --agent dancelessonscoachprogrammer
|
||||
👤 "Yes, document in ADR first"
|
||||
🤖 Creates adr/00XX-library-x.md
|
||||
🤖 Implements with BDD tests
|
||||
🤖 Updates CHANGELOG.md
|
||||
🤖 Updates AGENT_CHANGELOG.md
|
||||
```
|
||||
|
||||
## Implementation History
|
||||
@@ -108,10 +126,10 @@ vibe start --agent dancelessonscoachprogrammer
|
||||
|
||||
**Archiving**: When compaction needed:
|
||||
```bash
|
||||
git log --oneline -- CHANGELOG.md > CHANGELOG_archive.md
|
||||
echo "## Compact History (Last 5 Entries)" > CHANGELOG.md
|
||||
git log --oneline -- AGENT_CHANGELOG.md > AGENT_CHANGELOG_archive.md
|
||||
echo "## Compact History (Last 5 Entries)" > AGENT_CHANGELOG.md
|
||||
# Add last 5 entries from git history
|
||||
git log -5 --pretty=format:"### %ad%n- %s%n" -- CHANGELOG.md >> CHANGELOG.md
|
||||
git log -5 --pretty=format:"### %ad%n- %s%n" -- AGENT_CHANGELOG.md >> AGENT_CHANGELOG.md
|
||||
```
|
||||
|
||||
## 2026-04-05 - OpenAPI Documentation Implementation
|
||||
@@ -37,7 +37,7 @@ sources = [
|
||||
"${project_root}/pkg/bdd/README.md",
|
||||
"${project_root}/.vibe/skills/bdd_testing/SKILL.md",
|
||||
"${project_root}/.vibe/skills/commit_message/SKILL.md",
|
||||
"${project_root}/CHANGELOG.md"
|
||||
"${project_root}/AGENT_CHANGELOG.md"
|
||||
]
|
||||
|
||||
# Self-improvement through documentation learning
|
||||
@@ -102,7 +102,7 @@ vibe start --agent dancelessonscoachprogrammer
|
||||
1. **Before adding dependencies**: Agent asks for approval
|
||||
2. **Before architectural changes**: Agent checks ADR folder and asks
|
||||
3. **Before new features**: Agent verifies roadmap alignment
|
||||
4. **All decisions**: Documented in CHANGELOG.md
|
||||
4. **All decisions**: Documented in AGENT_CHANGELOG.md
|
||||
|
||||
## Workflow Constraints
|
||||
|
||||
@@ -119,7 +119,7 @@ vibe start --agent dancelessonscoachprogrammer
|
||||
|
||||
### Always Document
|
||||
- New architectural decisions in `adr/`
|
||||
- Feature implementations in CHANGELOG.md
|
||||
- Feature implementations in AGENT_CHANGELOG.md
|
||||
- Test scenarios in `features/`
|
||||
- API changes in AGENTS.md
|
||||
|
||||
|
||||
Reference in New Issue
Block a user