-
Notifications
You must be signed in to change notification settings - Fork 936
Add AGENTS.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.
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
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
815cca1
Add CLAUDE.md with project structure and commands
Kludex 168e916
Add AGENTS.md symlink to CLAUDE.md
Kludex a1da2b9
Merge branch 'main' into add-claude-md
Kludex 8e18866
Merge remote-tracking branch 'origin/main' into add-claude-md
Kludex c1b3931
Move guidance to AGENTS.md and address review feedback
Kludex 694c6b8
Merge remote-tracking branch 'upstream/add-claude-md' into add-claude-md
Kludex 9db4d25
Merge branch 'main' into add-claude-md
xrmx 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 @@ | ||
| CLAUDE.md |
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 @@ | ||
| # 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/`. | ||
|
xrmx marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## 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 | ||
|
xrmx marked this conversation as resolved.
Outdated
|
||
|
|
||
| - 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. | ||
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.