Skip to content

Add repository AGENTS guide#8174

Merged
jack-berg merged 4 commits intoopen-telemetry:mainfrom
opensourcevk:main
Mar 16, 2026
Merged

Add repository AGENTS guide#8174
jack-berg merged 4 commits intoopen-telemetry:mainfrom
opensourcevk:main

Conversation

@opensourcevk
Copy link
Copy Markdown
Contributor

Summary

  • add a root AGENTS.md with repository-specific guidance for working in opentelemetry-java
  • document module layout, build and test entry points, style expectations, and repo-specific constraints

Testing

  • not run (docs-only change)

@opensourcevk opensourcevk requested a review from a team as a code owner March 11, 2026 09:49
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.30%. Comparing base (839f235) to head (f7466f9).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #8174   +/-   ##
=========================================
  Coverage     90.29%   90.30%           
- Complexity     7650     7651    +1     
=========================================
  Files           843      843           
  Lines         23059    23061    +2     
  Branches       2309     2310    +1     
=========================================
+ Hits          20822    20826    +4     
+ Misses         1519     1516    -3     
- Partials        718      719    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

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

This reads like https://github.com/open-telemetry/opentelemetry-java/blob/main/CONTRIBUTING.md.

Can we not do a pass to modernize CONTRIBUTING.md and have a minimum AGENTS.md that redirects to CONTRIBUTING.md?

Things I don't want:

  • Maintain two copies of the same information
  • Prioritize machines over humans

@opensourcevk
Copy link
Copy Markdown
Contributor Author

This reads like https://github.com/open-telemetry/opentelemetry-java/blob/main/CONTRIBUTING.md.

Can we not do a pass to modernize CONTRIBUTING.md and have a minimum AGENTS.md that redirects to CONTRIBUTING.md?

Things I don't want:

  • Maintain two copies of the same information
  • Prioritize machines over humans

updated agents.md

@opensourcevk opensourcevk requested review from jack-berg and trask March 12, 2026 11:53
@opensourcevk opensourcevk requested a review from jack-berg March 13, 2026 02:04
Copy link
Copy Markdown
Contributor

@breedx-splk breedx-splk left a comment

Choose a reason for hiding this comment

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

reasonable starting point to me.

@opensourcevk
Copy link
Copy Markdown
Contributor Author

@jack-berg may i kindly request approval and merge please?

@jack-berg jack-berg merged commit 2acd434 into open-telemetry:main Mar 16, 2026
27 checks passed
@otelbot
Copy link
Copy Markdown
Contributor

otelbot bot commented Mar 16, 2026

Thank you for your contribution @opensourcevk! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

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.

5 participants