docs: add AGENTS.md with guidance for AI coding agents#3480
Merged
cijothomas merged 3 commits intoopen-telemetry:mainfrom May 1, 2026
Merged
docs: add AGENTS.md with guidance for AI coding agents#3480cijothomas merged 3 commits intoopen-telemetry:mainfrom
cijothomas merged 3 commits intoopen-telemetry:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3480 +/- ##
=====================================
Coverage 83.7% 83.7%
=====================================
Files 126 126
Lines 25386 25386
=====================================
Hits 21255 21255
Misses 4131 4131 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bryantbiggs
reviewed
Apr 30, 2026
bryantbiggs
reviewed
Apr 30, 2026
cijothomas
added a commit
to cijothomas/otel-arrow
that referenced
this pull request
Apr 30, 2026
GitHub Copilot, Cursor, and other agents read AGENTS.md, so the .github/copilot-instructions.md stub is no longer needed. Keep CLAUDE.md as a thin pointer to AGENTS.md since Claude Code is only guaranteed to read CLAUDE.md (see open-telemetry/opentelemetry-rust#3480 discussion).
bryantbiggs
approved these changes
Apr 30, 2026
lalitb
reviewed
May 1, 2026
lalitb
approved these changes
May 1, 2026
Co-authored-by: Lalit Kumar Bhasin <lalit_fin@yahoo.com>
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.
Changes
Adds an
AGENTS.mdat the repo root targeted at AI coding agents (GitHub Copilot, Claude, Cursor, etc.). Human contributors continue to use CONTRIBUTING.md; this file just consolidates the conventions an agent must respect to keep CI green and reviews short.What it covers
opentelemetry-prometheus).cargo fmt --all,cargo clippy -p <crate> --all-targets --all-features -- -Dwarnings, andcargo test -p <crate> --all-features --lib. Includes the equivalent invocations foropentelemetry-prometheus.scripts/precommit.sh— reserved for cross-crate changes, public API / trait / feature-flag changes, dependency bumps, build script / proto / codegen changes, or anything that could regress feature-gated builds. Small single-crate changes use the targeted commands.rustfmtenforced, clippy-Dwarnings, no unexplained#[allow(...)]).## vNext).Cargo.lock, don't add public API without updatingallowed-external-types.toml, don't author standalone "summary of changes" markdown files).scripts/precommit.sh,scripts/lint.sh,scripts/test.sh, and design docs.Why
AGENTS.mdis a community convention that several editors and agent runtimes (Copilot, Cursor, Claude Code, etc.) auto-load. Without it, agents end up pushing PRs that fail trivial CI checks (e.g. rustfmt) because they don't know aboutscripts/precommit.shand the workspace conventions. Having one short file at the root means contributors using agents get consistent behavior without rediscovering the setup each time.This PR is documentation-only — no code or build changes.