Skip to content

chore: add AGENTS.md to guide AI-assisted contributions#5089

Merged
xrmx merged 6 commits intoopen-telemetry:mainfrom
MikeGoldsmith:mike/agents-md
Apr 15, 2026
Merged

chore: add AGENTS.md to guide AI-assisted contributions#5089
xrmx merged 6 commits intoopen-telemetry:mainfrom
MikeGoldsmith:mike/agents-md

Conversation

@MikeGoldsmith
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith commented Apr 14, 2026

Description

Adds AGENTS.md to guide AI agents making contributions to this repository. Modelled after the equivalent file in opentelemetry-python-contrib#4233.

The file covers:

  • A link to the OTel community GenAI policy
  • The rule against posting AI-generated comments on issues/PRs
  • PR scoping guidance (no opportunistic cleanup)
  • Repo structure overview
  • Common commands for linting and testing
  • Coding guidelines
  • Commit Assisted-by: trailer convention

Also adds CLAUDE.md as a pointer to AGENTS.md for Claude-based tooling.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

N/A — documentation only.

Does This PR Require a Contrib Repo Change?

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner April 14, 2026 08:11
@MikeGoldsmith MikeGoldsmith added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Apr 14, 2026
@MikeGoldsmith MikeGoldsmith changed the title docs: add AGENTS.md to guide AI-assisted contributions chore: add AGENTS.md to guide AI-assisted contributions Apr 14, 2026
@MikeGoldsmith MikeGoldsmith moved this to Easy to review / merge / close in Python PR digest Apr 14, 2026
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md
MikeGoldsmith and others added 4 commits April 14, 2026 14:54
Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>
Assisted-by: Claude Sonnet 4.6
Assisted-by: Claude Sonnet 4.6
@github-project-automation github-project-automation bot moved this from Easy to review / merge / close to Approved PRs in Python PR digest Apr 14, 2026
@xrmx xrmx requested a review from emdneto April 15, 2026 07:34
@xrmx xrmx merged commit 5fa8b98 into open-telemetry:main Apr 15, 2026
466 checks passed
@github-project-automation github-project-automation bot moved this from Approved PRs to Done in Python PR digest Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants