chore: updated header comments for TODO and CHANGELOG
This commit is contained in:
18
roadmap/README.md
Normal file
18
roadmap/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# MarkiTect Project Roadmap
|
||||
|
||||
This roadmap directory contains planning directories for roadmap topics.
|
||||
- When starting to implement a topic its directory will be timestamped
|
||||
- If implementing multiple topics in parallel use branches
|
||||
- Keep current state of what's next to implement in TODO.md
|
||||
- See ../history directory for closed topics
|
||||
|
||||
## Purpose
|
||||
|
||||
This planning documentation serves multiple purposes:
|
||||
|
||||
1. **Implementation State Awareness**: Allow for recovery after breaks or breakdowns
|
||||
2. **Minimal Plan-Implement Loop**: Don't complicate agentic coding with issue tracking if unnecessary
|
||||
3. **Planning Info Analysis**: Keeping the planning info allows for retrospective analyses to optimize
|
||||
4. **Clean Repo Structure**: Using roadmap/ for planning and TODO.md as current state helps stay organized
|
||||
|
||||
xxx
|
||||
Reference in New Issue
Block a user