Skip to content

Commit 6ee8364

Browse files
committed
docs: require roadmap updates alongside features
Two releases shipped milestones without the roadmap following, leaving it claiming that implemented capabilities were missing. Make the update part of the pull request that changes what the project claims about itself, and say plainly that correcting a stale entry matters more than appending a new one.
1 parent 3d68535 commit 6ee8364

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ Write Minitest files as `test/**/*_test.rb`. Start behavioral changes with a foc
2828

2929
Use concise imperative subjects, preferably under 50 characters; use prefixes such as `fix:`, `ci:`, or `chore:`. Pull requests should explain API, correctness, security, migration, and compatibility effects; list exact validation commands; link issues; and include screenshots for UI or reactive ERB changes. Never bypass hooks or add AI attribution.
3030

31+
Update `docs/roadmap.md` in the same pull request whenever the change alters
32+
what the project claims about itself. That includes completing or advancing a
33+
numbered milestone, moving an entry between "Implemented and tested" and
34+
"Partially implemented", and discovering a limitation worth recording, such as a
35+
capability that turns out to be opt-in, adapter-specific, or measured rather
36+
than assumed. Prefer correcting a stale entry over only appending a new one: an
37+
inaccurate claim misleads more than a missing one. State what was measured and
38+
what was not, so a reader can tell evidence from intent. A change that only
39+
fixes a defect, adjusts tooling, or edits prose does not need a roadmap edit.
40+
3141
## Release Workflow
3242

3343
Update the version, `CHANGELOG.md`, and `Gemfile.lock`; run `bundle exec rake`; then commit and push `main`. Publish by pushing an annotated version tag:

0 commit comments

Comments
 (0)