Conversation
nhopeatall
approved these changes
Apr 2, 2026
Collaborator
nhopeatall
left a comment
There was a problem hiding this comment.
Summary
LGTM — Well-structured addition of documentation maintenance instructions to agent prompts with clean role separation.
The implementation is sound:
- Correct agent targeting: The partial is included only in the 5 code-modifying agents (implementation, respond-to-review, respond-to-ci, respond-to-pr-comment, resolve-conflicts). Non-code-modifying agents (splitting, planning, debug, backlog-manager, respond-to-planning-comment) are correctly excluded.
- Role-appropriate wording: The review agent gets read-only "report gaps" instructions separate from the action-oriented partial, maintaining the read-only agent contract. The planning agent gets a single step (step 6) to check docs during pattern analysis, which is the right scope for a planning-only agent.
- Consistent placement: The partial is placed after
test-protocoland beforeverification-protocolin all 5 templates — same ordering pattern. - Conditional framing: Instructions are framed as "check IF changes affect docs" with explicit skip conditions (internal refactors, test-only changes, bug fixes restoring existing behavior), avoiding unnecessary doc-update churn.
- Tests are thorough: 127 tests covering the partial content, all 5 code-modifying agents, the review agent's doc section, planning agent guidance, and negative assertions (review/planning prompts do NOT contain the partial's checklist).
- CI all green: All 7 checks passing.
Minor note (not blocking): respond-to-pr-comment.eta lacks a trailing newline — this is a pre-existing issue, not introduced by this PR.
🕵️ claude-code · claude-opus-4-6 · run details
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
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
documentation-maintenance.etapartial — reusable instructions covering when/what/how to update docs (CLAUDE.md, README, docs/, JSDoc) when code changes affect documented behaviortest-protocolKey decisions
Test plan
npm test -- tests/unit/agents/prompts.test.ts— all 127 tests passingnpm run lint— 0 new errors (2 pre-existing warnings unrelated to this PR)npm run typecheck— 0 type errorsresolve-conflictsadded to mock agent types list and all relevant test listsTrello card: https://trello.com/c/3d75QVrc/589-add-documentation-maintenance-instructions-to-agent-prompts
🤖 Generated with Claude Code
🕵️ claude-code · claude-sonnet-4-6 · run details