docs(comment-policy): sync agent-prompt-surface guidance from upstream (SD-2923) - #3110
Merged
Merged
Conversation
…m (SD-2923) Two changes from the upstream comment-policy at github.com/caiopizzol/comment-bench: - "Treat stale comments as bugs" now spells out why: in agent-heavy codebases, comments are prompt surface. A stale comment is not decoration; it becomes the next instruction. - New "Treat agent-facing docs as comments" section: extends the policy to README.md, AGENTS.md, CLAUDE.md, runbooks, tutorials. A stale root instruction is more dangerous than a stale inline comment because agents may treat it as project policy. Snippet's last line bumped to "Treat stale comments and stale agent-facing docs as bugs." The local "Loaded terms" taxonomy is untouched.
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.
Picks up two improvements from the upstream
comment-policyreference at github.com/caiopizzol/comment-bench:README.md,AGENTS.md,CLAUDE.md, runbooks, and tutorials. A stale root instruction is arguably more dangerous than a stale inline comment because agents treat it as project policy.The local "Loaded terms" taxonomy added in #3103 is untouched. The
CLAUDE.md / AGENTS.mdsnippet's final line bumped to "Treat stale comments and stale agent-facing docs as bugs."Related: SD-2923 (comment hygiene umbrella).