Skip to content

Contributing

We welcome contributions to the OpenTelemetry Gunicorn Instrumentation project!

Development Setup

# Clone the repository
git clone https://github.com/Agent-Hellboy/opentelemetry-instrumentation-gunicorn.git
cd opentelemetry-instrumentation-gunicorn

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies (including dev tools for linting/formatting)
pip install -e .[test,docs,dev]

# Install pre-commit hooks
pre-commit install

Running Tests

# Run unit tests
tox -e py

# Run e2e tests (requires Docker)
tox -e e2e

# Or run tests directly with pytest
pytest
pytest tests/test_e2e_metrics.py

Development Workflow

  1. Choose an Issue - Check GitHub Issues

  2. Create a Branch

git checkout -b feature/your-feature-name

  1. Make Changes - Write tests, follow existing code style

  2. Commit Changes

git add .
git commit -m "feat: add new feature"
  1. Push and Create PR
git push origin feature/your-feature-name
# Create Pull Request on GitHub

Code Quality

Code Style

  • Follow PEP 8
  • Use type hints
  • Maximum line length: 88 characters

Development Tools

The project uses the following tools (included in dev dependencies):

  • Ruff: Fast Python linter and formatter
  • Mdformat: Markdown formatter with GitHub Flavored Markdown support

Quality Checks

# Run all quality checks (Python + Markdown linting)
tox -e lint

# Format all code (Python + Markdown)
tox -e format

# Or use pre-commit (runs automatically on commit)
pre-commit run --all-files

Run tox -e lint before committing to ensure code quality.

Getting Help

Thank you for contributing! 🚀