Skip to content

docs: clarify when to update agent context - #755

Merged
Brentlok merged 1 commit into
mainfrom
docs/update-agents-instruction
Oct 28, 2026
Merged

Brentlok merged 1 commit into
mainfrom
docs/update-agents-instruction

Conversation

@Brentlok

@Brentlok Brentlok commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • 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.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Walkthrough

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.

Priority: Not assessed

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: jpudysz

Merge Risk: Minimal · up to 44f62

The updated documentation is mergeable with no actionable implementation risk identified.

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This documentation-only change appears safe to merge.

Summary

Clarifies when agents should update CONTEXT.md.

  • Agents update context only when lasting guidance needs to change.

Reviews (1) · Last reviewed commit: "docs: clarify when to update agent conte..." · Reviewed by Greptile

@Brentlok
Brentlok merged commit bbe33af into main Oct 28, 2026
2 of 3 checks passed
@Brentlok
Brentlok deleted the docs/update-agents-instruction branch October 28, 2026 09:12
@github-actions

Copy link
Copy Markdown
Contributor

🚀 This pull request is included in v1.13.1. See Release v1.13.1 for release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant