Rework CONTRIBUTING.md, extracting bits to new /docs/knowledge/* for …#8303
Open
jack-berg wants to merge 4 commits intoopen-telemetry:mainfrom
Open
Rework CONTRIBUTING.md, extracting bits to new /docs/knowledge/* for …#8303jack-berg wants to merge 4 commits intoopen-telemetry:mainfrom
jack-berg wants to merge 4 commits intoopen-telemetry:mainfrom
Conversation
…improved human and agent experience
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8303 +/- ##
=========================================
Coverage 90.26% 90.26%
Complexity 7688 7688
=========================================
Files 850 850
Lines 23198 23198
Branches 2354 2354
=========================================
Hits 20940 20940
Misses 1531 1531
Partials 727 727 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
trask
approved these changes
Apr 17, 2026
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.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.
…improved human and agent experience
Motivated by work from @trask and friends on introducing https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/.github/agents/knowledge, and interesting tools to automatically apply conventions to individual modules.
Also, we recently introduced a simple AGENTS.md in #8174. On that PR, I commented that we're long over due for a modernization of
CONTRIBUTING.md.This PR lays the foundation:
CONTRIBUTING.mdto cover project process and scope.docs/knowledgedocs/knowlegeto be consumable by humans and machines:something is a strong convention, it's described as such. Where something is a matter of
judgment, it's described that way too.
docs/knowledge/README.mdacts as an index to individual documents, with instructions agents can use to determine when to load.AGENTS.mdto follow instructions fromdocs/knowledge/README.md