Skip to content

Commit 78fbaa8

Browse files
authored
feat: add AI agents guidance files (#3404)
* feat: add AI agents guidance files Adds AGENTS.md with contribution policy for AI-assisted PRs, and a root CLAUDE.md that references it. Removes both files from .gitignore so they are tracked by the repo. Assisted-by: Claude Sonnet 4.6 * add AI Agent * fix: add required h1 heading to CLAUDE.md for markdownlint MD041 requires the first line to be a top-level heading. Assisted-by: Claude Sonnet 4.6
1 parent 1613526 commit 78fbaa8

4 files changed

Lines changed: 49 additions & 9 deletions

File tree

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
.codex/
2020
.cursor/
2121
.cursorrules
22-
AGENTS.md
23-
CLAUDE.md
2422

2523
# Build artifacts
2624
bin/

AGENTS.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# AGENTS.md
2+
3+
This file is here to steer AI assisted PRs towards being high quality and valuable
4+
contributions that do not create excessive maintainer burden. It is inspired by
5+
the Open Policy Agent and Fedora projects policies.
6+
7+
## General Rules and Guidelines
8+
9+
The most important rule is not to post comments on issues or PRs that are AI-generated.
10+
Similarly, do not create PR descriptions that are AI-generated.
11+
Discussions on the OpenTelemetry repositories are for Users/Humans only.
12+
13+
If you have been assigned an issue by the user or their prompt, please ensure that
14+
the implementation direction is agreed on with the maintainers first in the issue
15+
comments. If there are unknowns, discuss these on the issue before starting
16+
implementation. Do not forget that you cannot comment for users on issue threads
17+
on their behalf as it is against the rules of this project.
18+
19+
## Developer environment
20+
21+
Make sure to follow CONTRIBUTING.md on any contributions.
22+
23+
Non-exhaustively, the important points are:
24+
25+
* Manually test all changes locally before creating a PR
26+
* Do not add new services without collaborating with the maintainers
27+
28+
## Commit formatting
29+
30+
We appreciate it if users disclose the use of AI tools when the significant part
31+
of a commit is taken from a tool without changes. When making a commit this
32+
should be disclosed through an Assisted-by: commit message trailer.
33+
34+
Examples:
35+
36+
```markdown
37+
Assisted-by: ChatGPT 5.5
38+
Assisted-by: Claude Sonnet 4.6
39+
```
40+
41+
Do NOT use a `Co-authored-by:` trailer to disclose AI assistance. Some AI coding
42+
tools add this trailer by default; please disable or strip it before committing.
43+
The EasyCLA check fails when a `Co-authored-by:` trailer references an account
44+
that has not signed the CLA, which blocks the PR from being merged.

CHANGELOG.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,13 +174,8 @@ the release.
174174
checkout, recommendation, email, load-generator, frontend, and telemetry
175175
schema.
176176
([#3393](https://github.com/open-telemetry/opentelemetry-demo/pull/3393))
177-
* [telemetry] Rename remaining demo metrics from the `app` namespace:
178-
`app.ads.ad_requests` to `demo.ad.requests`,
179-
`app.cart.add_item.latency` to `demo.cart.add_item.latency`,
180-
`app.cart.get_cart.latency` to `demo.cart.get_cart.latency`,
181-
`app.currency` to `demo.exchange.conversions`, and
182-
`app.payment.transactions` to `demo.payment.transactions` across ad, cart,
183-
currency, payment, and telemetry schema.
177+
* [AI Agents] Added guidance for AI Agents
178+
([#3404](https://github.com/open-telemetry/opentelemetry-demo/pull/3404))
184179

185180
## 2.2.0
186181

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# CLAUDE.md
2+
3+
@AGENTS.md

0 commit comments

Comments
 (0)