Skip to content

Add CLAUDE.md with project structure and commands #4233

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.

Sign up for GitHub

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

Open
Kludex wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add CLAUDE.md with project structure and commands #4233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
815cca1
Add CLAUDE.md with project structure and commands
Kludex Feb 20, 2026
168e916
Add AGENTS.md symlink to CLAUDE.md
Kludex Feb 22, 2026
a1da2b9
Merge branch 'main' into add-claude-md
Kludex Feb 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CLAUDE.md
36 changes: 36 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Copy link
Member

@aabmass aabmass Feb 20, 2026

Choose a reason for hiding this comment

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

Can we rename to AGENTS.md or symlink to it?

Copy link
Member Author

@Kludex Kludex Feb 22, 2026

Choose a reason for hiding this comment

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

I don't think Claude checks AGENTS.md, or there's a setting to change that. I've added a symlink.

Copy link
Member

@MikeGoldsmith MikeGoldsmith Feb 23, 2026

Choose a reason for hiding this comment

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

I think the main content should be in AGENTS.md then add @AGENTS.md to CLAUDE.md - see here.

This makes sure other agents (co-pilot, cursor, etc) follow the guidance, not just Claude.

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OpenTelemetry Python Contrib

Monorepo with 50+ OpenTelemetry instrumentation packages for Python.

## Structure

- `instrumentation/` - instrumentation packages (Flask, Django, FastAPI, gRPC, databases, etc.)
- `instrumentation-genai/` - GenAI instrumentations (Anthropic, Vertex AI, LangChain, etc.)
- `util/` - shared utilities (`util-http`, `util-genai`)
- `exporter/` - custom exporters
- `propagator/` - context propagators

Each package lives under `src/opentelemetry/instrumentation/{name}/` with its own `pyproject.toml` and `tests/`.
Copy link
Contributor

@xrmx xrmx Feb 24, 2026

Choose a reason for hiding this comment

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

src/opentelemetry/instrumentation is only for instrumentations


## Commands

```sh
# Install all packages and dev tools
uv sync --frozen --all-packages

# Lint (runs ruff via pre-commit)
uv run pre-commit run ruff --all-files

# Test a specific package (append -0, -1, etc. for version variants)
uv run tox -e py312-test-instrumentation-flask-0

# Type check
uv run tox -e typecheck
```

## Guidelines
Copy link
Member

@MikeGoldsmith MikeGoldsmith Feb 23, 2026

Choose a reason for hiding this comment

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

There are some other nice bits in the AGENTS file the Collector added, especially the Assisted-by commit annotation.

Copy link
Contributor

@xrmx xrmx Feb 24, 2026

Choose a reason for hiding this comment

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

Yes, please. I think we also have started to receive PRs from bot / people throwing a bot at good-first-issue labeled issues.


- Each package has its own `pyproject.toml` with version, dependencies, and entry points.
- The monorepo uses `uv` workspaces.
- `tox.ini` defines the test matrix - check it for available test environments.
- Do not add `type: ignore` comments. If a type error arises, solve it properly or write a follow-up plan to address it in another PR.
Loading