You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarify that CONTEXT.md should change only when guidance becomes materially incorrect or a lasting decision or support contract needs documenting.
Note that routine fixes, refactors, optimizations, tests, and dependency bumps normally do not need context updates.
Testing
git diff --check
Summary by CodeRabbit
Documentation
Clarified that long-term architectural guidance and support commitments should be documented, while routine fixes, refactors, optimizations, tests, and dependency updates generally do not need documentation updates.
Clarified that implementation details belong in code and tests rather than serving as a changelog in the guidance documents.
The update changes guidance in AGENTS.md and CONTEXT.md. Both documents now limit CONTEXT.md updates to lasting architectural guidance or support contracts and state that implementation details belong in code and tests.
Changes: Context documentation guidance
Layer / File(s)
Summary
Document update criteria AGENTS.md, CONTEXT.md
Both documents now say to update CONTEXT.md when existing guidance becomes materially incorrect or a lasting architectural decision or support contract needs documentation. Routine changes normally do not require an update. Implementation details belong in code and tests.
🚀 This pull request is included in v1.13.1. See Release v1.13.1 for release notes.
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
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
CONTEXT.mdshould change only when guidance becomes materially incorrect or a lasting decision or support contract needs documenting.Testing
git diff --checkSummary by CodeRabbit