Skip to content

Solution for long term memory for agent coding CLIs and to facilitate handoff between different agent vendors

Rust

docs(contributing): make the CHANGELOG entry an explicit merge gate

AkitaOnRails08ebec6488da
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index bcb657ed..fc0818f8 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -13,6 +13,18 @@
- [ ] `cargo test --workspace` passes
- [ ] Manual test: <!-- describe what you ran and what you observed -->
+## CHANGELOG (merge gate)
+
+- [ ] I added a `CHANGELOG.md` `[Unreleased]` entry — **required** for any
+ user-facing change: new flag / env var / endpoint / MCP tool / marker
+ key, changed behaviour, or an observable bug fix. (Exempt only for
+ internal refactors, dead-code removal, and test-only churn.)
+- [ ] Any changed **default** (flag behaviour, config default, env var,
+ response shape) is called out explicitly in "What changed" above.
+
+Reviewers treat a missing entry as blocking — adding it up front is what
+keeps your PR merging on the first pass.
+
## Notes for reviewers
<!-- Anything tricky, a design decision you made, or areas you'd like extra scrutiny on. -->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 545116ac..86b0fb6c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,9 +32,26 @@ If `cargo-deny` or `cargo-audit` are not installed:
cargo install cargo-deny cargo-audit
```
-## Workflow rules (condensed from CLAUDE.md)
+## CHANGELOG is a merge gate
-The full authoritative rules are in [`CLAUDE.md`](CLAUDE.md). Short version:
+Every **user-facing** change must add a `CHANGELOG.md` entry under
+`## [Unreleased]` in the same PR. User-facing means: a new CLI flag or
+subcommand, env var, HTTP/admin endpoint, MCP tool or tool-response field,
+`.ai-memory.toml` marker key, any changed behaviour or default, or an
+observable bug fix. Internal refactors, dead-code removal, and test-only
+churn are exempt.
+
+This has been the single most-forgotten obligation across review batches,
+so reviewers treat a missing entry as **blocking** — the PR template has a
+checkbox for it. Follow the existing entry style (past-tense summary,
+trailing `([#NNN])` PR/issue reference) and place it under the right
+`### Added` / `### Changed` / `### Fixed` heading.
+
+## Workflow rules (condensed from AGENTS.md)
+
+The full authoritative rules are in [`AGENTS.md`](AGENTS.md) — the single
+canonical agent/contributor rules file (`CLAUDE.md` is just a pointer to
+it). Short version:
1. Work milestone by milestone. Do not start M(n+1) until every "Done when"
bullet in M(n) passes (see `docs/design-decisions.md`).
@@ -49,7 +66,8 @@ The full authoritative rules are in [`CLAUDE.md`](CLAUDE.md). Short version:
## Cross-cutting invariants
-Never violate any of the invariants in `CLAUDE.md §Cross-cutting invariants`.
+Never violate any of the invariants in [`AGENTS.md`](AGENTS.md) (see the
+"Rust Engineering Rules" and "Project Maintenance Rules" sections).
Highlights for contributors:
- All SQLite writes go through the single writer actor (`WriterHandle`).