Skip to content

docs: deduplicate AGENTS.md rules into nested files (#857) - #1020

Merged
lmolkova merged 2 commits into
open-telemetry:mainfrom
VimalN2005:refactor/deduplicate-agents-md-857
Nov 2, 2026
Merged

lmolkova merged 2 commits into
open-telemetry:mainfrom
VimalN2005:refactor/deduplicate-agents-md-857

Conversation

@VimalN2005

Copy link
Copy Markdown
Contributor

Fixes #857

What does this change do?

Reorganizes agent instruction files across the repo by moving instrumentation-specific rules from the root AGENTS.md into instrumentation/AGENTS.md, deduplicating overlapping sections (Streaming responses, Exception handling), and leaving lightweight pointers at the root. This reduces the root file from 429 lines to ~156 lines.

Why?

Tooling guidance recommends keeping agent instruction files under ~200 lines to preserve adherence. Scoping detailed instrumentation and util rules to their nested directories ensures agents load them on demand without paying for them at repo startup, while eliminating duplicated guidance that could drift.

Known gaps or concerns

None. Formatting checked with ruff format --preview.

Copilot AI balanced review requested due to automatic review settings October 31, 2026 18:41
@VimalN2005
VimalN2005 requested a review from a team as a code owner October 31, 2026 18:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Pull request dashboard status

Merged · refreshed 2026-11-02 23:12 UTC

Status above doesn't look right?
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

Comment thread AGENTS.md Resolved
Comment thread instrumentation/AGENTS.md Resolved

@MikeGoldsmith MikeGoldsmith left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VimalN2005 👍🏻

@lmolkova
lmolkova added this pull request to the merge queue Nov 2, 2026
Merged via the queue into open-telemetry:main with commit cf1b56a Nov 2, 2026
84 of 85 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PR does not require a changelog entry

Development

Successfully merging this pull request may close these issues.

Review AGENTS.md size and duplication against the nested files

4 participants