CONTRIBUTING.MD

Getting Started with Local Development

Before starting, you'll need to ensure you have the appropriate version of Python installed.

Python 3

1. Install the virtual environment manager: python3 -m pip install virtualenv
2. Navigate to the project directory: cd <project folder>
3. Create a new virtual environment using Python 3: python3 -m virtualenv venv3
4. Activate the virtual environment. On Windows, use venv3\Scripts\activate. On Unix or MacOS, use source venv3/bin/activate.
5. Install the development dependencies and prepare local package: python3 -m pip install -e .[dev]
6. Run tests with the command:

pytest

To run tests with coverage:

pytest --cov=python3/raygun4py --cov-report=term-missing

Code Quality

This project uses Ruff for linting and formatting.

# Check formatting
ruff format --check python3/

# Fix formatting
ruff format python3/

# Run linter
ruff check python3/

# Fix auto-fixable lint issues
ruff check --fix python3/

• Remember to deactivate the virtual environment when you're done: deactivate