docs: add ROADMAP.md and ADR-003 for canonical planning artefact#269
Merged
Conversation
Closes #167 Create docs/ROADMAP.md as the canonical planning artefact to address audit finding §10. The roadmap captures current, next, and future releases with explicit tracking of the two major outstanding work items: - NATS subscriber for task-lifecycle events (#92) - Persistent workflow-state backend for status/list/cancel (v1.0.0) Add ADR-003 documenting the decision to use docs/ROADMAP.md as the canonical planning artefact instead of GitHub Projects alone. Wire discoverability links from README.md, CLAUDE.md, CONTRIBUTING.md, the PR template, and CHANGELOG.md so the roadmap is discoverable from multiple entry points. Add tests/test_roadmap.py with six regression tests pinning: 1. Existence of docs/ROADMAP.md 2. Required H2 sections (Current Release, Next Release, Future, Known Limitations) 3. Explicit reference to NATS subscriber and state backend 4. Canonical GitHub remote URL (HomericIntelligence/ProjectTelemachy) 5. ADR link resolution (no dead pointers) 6. ADR-003 presence and Accepted status All existing tests pass (77% coverage, gate: 75%); linting passes. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com> Signed-off-by: mvillmow <4211002+mvillmow@users.noreply.github.com>
GHSA-4xgf-cpjx-pc3j) Signed-off-by: Micah Villmow <4211002+mvillmow@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #167
Create
docs/ROADMAP.mdas the canonical planning artefact to address audit finding §10. The roadmap captures current, next, and future releases with explicit tracking of the two major outstanding work items:Test plan
just test— 54 tests, 77% coverage, gate 75%).just lint).test_roadmap.py).🤖 Generated with Claude Code