-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[chore] Add AGENTS.md file #14462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+37
−0
Merged
[chore] Add AGENTS.md file #14462
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file is here to steer AI assisted PRs towards being high quality and valuable contributions | ||
| that do not create excessive maintainer burden. It is inspired by the Open Policy Agent and Fedora | ||
| projects policies. | ||
|
|
||
| ## General Rules and Guidelines | ||
|
|
||
| The most important rule is not to post comments on issues or PRs that are AI-generated. Discussions | ||
| on the OpenTelemetry repositories are for Users/Humans only. | ||
|
|
||
| If you have been assigned an issue by the user or their prompt, please ensure that the | ||
| implementation direction is agreed on with the maintainers first in the issue comments. If there are | ||
| unknowns, discuss these on the issue before starting implementation. Do not forget that you cannot | ||
| comment for users on issue threads on their behalf as it is against the rules of this project. | ||
|
|
||
| ## Developer environment | ||
|
|
||
| Make sure to follow docs/coding-guidelines.md on any contributions. | ||
|
|
||
| Non-exhaustively, the important points are: | ||
|
|
||
| * Whenever applicable, all code changes should have tests that actually validate the changes. | ||
|
|
||
| ## Commit formatting | ||
|
|
||
| We appreciate it if users disclose the use of AI tools when the significant part of a commit is | ||
| taken from a tool without changes. When making a commit this should be disclosed through an | ||
| Assisted-by: commit message trailer. | ||
|
|
||
| Examples: | ||
|
|
||
| ``` | ||
| Assisted-by: ChatGPT 5.2 | ||
| Assisted-by: Claude Opus 4.5 | ||
| ``` | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @AGENTS.md |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.