Skip to content

Add AGENTS.md with project structure and commands#4233

Merged
xrmx merged 7 commits into
open-telemetry:mainfrom
Kludex:add-claude-md
Apr 14, 2026
Merged

Add AGENTS.md with project structure and commands#4233
xrmx merged 7 commits into
open-telemetry:mainfrom
Kludex:add-claude-md

Conversation

@Kludex
Copy link
Copy Markdown
Member

@Kludex Kludex commented Feb 20, 2026

Based on discussion from last week's meeting.

It's minimal.


You can't prevent people from spamming your repo with thousands of AI based PRs, but you can guide their AI to do the right thing.

@Kludex Kludex requested a review from a team as a code owner February 20, 2026 10:32
Copy link
Copy Markdown
Member

@aabmass aabmass left a comment

Choose a reason for hiding this comment

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

Looks like a good starting point, thanks!

Comment thread CLAUDE.md
@aabmass aabmass added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 20, 2026
Comment thread CLAUDE.md
@MikeGoldsmith MikeGoldsmith mentioned this pull request Feb 23, 2026
10 tasks
Comment thread CLAUDE.md Outdated
@tammy-baylis-swi tammy-baylis-swi moved this to Approved PRs in Python PR digest Feb 23, 2026
@tammy-baylis-swi tammy-baylis-swi moved this from Approved PRs to Ready for review in Python PR digest Feb 23, 2026
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
@tammy-baylis-swi tammy-baylis-swi moved this from Ready for review to Reviewed PRs that need fixes in Python PR digest Feb 26, 2026
Kludex added 3 commits April 10, 2026 10:39
- Move main content from CLAUDE.md to AGENTS.md so all AI agents
  (not only Claude) pick up the guidance; CLAUDE.md now just references
  it via `@AGENTS.md`.
- Add general rules, PR scoping, and `Assisted-by:` commit trailer
  guidance (inspired by the Collector's AGENTS.md).
- Clarify that only instrumentation packages live under
  `src/opentelemetry/instrumentation/{name}/`; other package types use
  their own namespace.
@xrmx xrmx requested a review from MikeGoldsmith April 10, 2026 16:05
@xrmx xrmx moved this from Reviewed PRs that need fixes to Approved PRs in Python PR digest Apr 10, 2026
Copy link
Copy Markdown
Member

@MikeGoldsmith MikeGoldsmith left a comment

Choose a reason for hiding this comment

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

Looks good - thanks @Kludex 👍🏻

@MikeGoldsmith MikeGoldsmith changed the title Add CLAUDE.md with project structure and commands Add AGENTS.md with project structure and commands Apr 12, 2026
@MikeGoldsmith
Copy link
Copy Markdown
Member

Hmm, on second thought - maybe we should remove the recommendation for the assisted-by commit trailer. Kubernetes has moved to disallow it because it's been used by some projects as a marketing gimmick.

Kat Cosgrove LinkedIn post - https://www.linkedin.com/posts/katcosgrove_pull-request-process-activity-7448418179258933248-iA2n
Kubernetes AI Guidance - https://www.kubernetes.dev/docs/guide/pull-requests/#ai-guidance

@MikeGoldsmith
Copy link
Copy Markdown
Member

After some more discussion, OpenTelemetry still advises using the assisted-by commit trailer in it's GenAI policy. Probably okay to leave in for now 👍🏻.

@xrmx xrmx merged commit baffc8c into open-telemetry:main Apr 14, 2026
750 checks passed
@github-project-automation github-project-automation Bot moved this from Approved PRs to Done in Python PR digest Apr 14, 2026
shuningc pushed a commit to shuningc/opentelemetry-python-contrib that referenced this pull request Apr 16, 2026
* Add CLAUDE.md with project structure and commands

* Add AGENTS.md symlink to CLAUDE.md

* Move guidance to AGENTS.md and address review feedback

- Move main content from CLAUDE.md to AGENTS.md so all AI agents
  (not only Claude) pick up the guidance; CLAUDE.md now just references
  it via `@AGENTS.md`.
- Add general rules, PR scoping, and `Assisted-by:` commit trailer
  guidance (inspired by the Collector's AGENTS.md).
- Clarify that only instrumentation packages live under
  `src/opentelemetry/instrumentation/{name}/`; other package types use
  their own namespace.

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
aabmass pushed a commit that referenced this pull request Apr 16, 2026
* linting fix

* Updating changelog

* Updating changelog PR number

* Removing embedding events emission

* Refatoring and adding input token metric for Embedding invocation

* Merging and removing unused import

* build(deps): bump aiohttp from 3.13.3 to 3.13.4 (#4386)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-version: 3.13.4
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Revert "Build list of required jobs in generate-workflow (#4326)" (#4413)

This reverts commit 22879d6.

Now that we have just one job to check we don't need to build the list anymore.

* Drop Python 3.9 support (#4412)

* Drop Python 3.9 support

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* generate-workflows

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* fixes

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* remove extra reference to pypy310

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* changelog

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* fix flask tests

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* fix google-genai tests

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* fix google-genai tests

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* fix

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

* remove unused _ensure_gzip_single_response

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

---------

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

* Add AGENTS.md with project structure and commands (#4233)

* Add CLAUDE.md with project structure and commands

* Add AGENTS.md symlink to CLAUDE.md

* Move guidance to AGENTS.md and address review feedback

- Move main content from CLAUDE.md to AGENTS.md so all AI agents
  (not only Claude) pick up the guidance; CLAUDE.md now just references
  it via `@AGENTS.md`.
- Add general rules, PR scoping, and `Assisted-by:` commit trailer
  guidance (inspired by the Collector's AGENTS.md).
- Clarify that only instrumentation packages live under
  `src/opentelemetry/instrumentation/{name}/`; other package types use
  their own namespace.

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

* scripts: drop update_sha (#4430)

It's buggy and unused.

* Fix pylint false positives for ThreadPoolExecutor (#4244)

* Bump pylint to 4.0.5 to fix Python 3.14 concurrent.futures false positives

* Fix too-many-positional-arguments pylint failures - Add max-positional-arguments=10, Add pylint: disable=too-many-positional-arguments to functions that legitimately exceed the limit

* Bump max-positional-arguments to 12 and remove unnecessary disable comments

* Address review comments: fix CHANGELOG, remove stale pylintrc comment, add openai-agents disable

* Fix formatting: restore blank line in CHANGELOG and remove extra blank line in .pylintrc

* Update processor.py

* Update test_botocore_bedrock.py

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

* feat(util-genai): refactor and make API smaller and more user-friendly (#4391)

* Refactor public API on GenAI utils

* more lint

* review feedback

* update tests to use named params

* address some of the comments

* up

* fix failing checks and clean up imports

* lint

* lint

* fix lint

* replace @deprecated with docstring info to avoid warnings for users

* up

* common code for context manager

* Adding metrics call for Embedding type after refactoring

* Updating metrics tests with embedding

* Adding fix for markdown-link-check

---------

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Sri Kaaviya <107148069+srikaaviya@users.noreply.github.com>
Co-authored-by: Liudmila Molkova <neskazu@gmail.com>
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.

5 participants