5bccda19d3
- Rewrite the snapshot-test RFC's replay-plugin section to state current reality directly (the plugin is the @deepseek-ai/dsh-llm-replay package, under the coverage gate) instead of keeping the old example-local text with a "superseded" note bolted on. - Add docs/rfc/implemented/AGENTS.md (+ CLAUDE.md symlink): an implemented RFC must be kept current with what actually shipped — update paths/names/structure in the same change that moves the code, in place, not as an append-only changelog of its own drift. A reversal of the DECISION is still a new RFC. - Reconcile docs/rfc/README.md: the "never edited into a different decision" rule now distinguishes tracking where a decision lives (required) from flipping the decision (forbidden), and the implemented/ bullet points at the new convention.
1.9 KiB
AGENTS.md — Implemented RFCs
These are RFCs whose decision has shipped. The repo-wide and docs-wide rules still apply (root AGENTS.md § "Type Safety and Documentation", docs/AGENTS.md); this file adds one rule specific to this folder.
Keep an implemented RFC current with what actually shipped
An RFC in implemented/ describes a decision that is now live code. Keep its description of the shipped reality accurate: when the implementation later moves a file, renames a package or symbol, changes a config key/default/error code, or relocates a plugin, update the RFC in the same change that touches the code — exactly as you would a package README. A stale implemented RFC (pointing at a path that no longer exists, naming a package that was renamed, describing a structure that was refactored) is worse than no RFC: a future reader trusts it and is misled.
Update it in place to state the current truth. Do not leave the outdated text in and bolt on a "superseded / now actually…" note — that makes the document a changelog of its own drift and forces the reader to reconstruct the present from a pile of corrections. Write what is true now.
This is not a license to rewrite the decision
Keeping the shipped-state description current is about facts (paths, names, structure, defaults) — not about silently flipping the decision and its rationale into a different one. If the underlying choice itself is reversed or materially changed (not just relocated), that is a new decision: write a new RFC and cross-link, per rfc/README.md ("An RFC is never edited into a different decision"). The line: a refactor that moves where the decision is realized → edit this RFC to match; a reversal of what was decided → a new RFC.
When in doubt, ask whether a reader following this RFC to the code would land on something real. If not, it needs updating.