open-telemetry / open-telemetry/opentelemetry-python-contrib

is contribution.md is out of date?

Open
#2,807 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

What problem do you want to solve?

These days I am trying to fix an issue with this project, follow the instruction illustrated in CONTRIBUTING.md, but found it is so hard to setup a local environment supporting debugging code, yes there is tox script which helps run test case as a black box, but how to setup dependency/debug some specific code(unittest) is not mentioned at all.

e.g. it depends on few projects under https://github.com/open-telemetry/opentelemetry-python.git, we need pip install them manually first(that is my practice, I might make silly mistake).

I think we might need add a little more explanation in order to help the new contributor to setup their working environments. I summarized a little, hopefully it is useful for the new contributors, thanks

  1. setup a clean python venv, suggest pyenv to manage xenv, windows fork at https://github.com/pyenv-win/pyenv-win
  2. git clone https://github.com/open-telemetry/opentelemetry-python.git
    install dependencies:
    pip install -e ./opentelemetry-api -e ./opentelemetry-sdk -e ./opentelemetry-semantic-conventions -e ./tests/opentelemetry-test-utils
  3. git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
    install the dependencies for a specific project in this repo, e.g.
    pip install -e instrumentation/opentelemetry-instrumentation-httpx
  4. pytest test_httpx_integration.py
Describe the solution you'd like

n/a

Describe alternatives you've considered

No response

Additional Context

No response

Would you like to implement a fix?

None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with CONTRIBUTING.md and compare its setup instructions with the issue's clean Python virtual environment and dependency installation steps. Follow the setup for the referenced OpenTelemetry repositories, then run pytest test_httpx_integration.py to verify the documented workflow. Done means contributors can install the required dependencies and debug a specific test using the guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.