Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (60 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

76 lines (60 loc) · 2.2 KB

Contributing to PyOctaveBand

Thank you for your interest in contributing to PyOctaveBand! We welcome contributions from the community to help improve this project.

🛠️ Development Setup

To set up your development environment:

  1. Clone the repository:

    git clone https://github.com/jmrplens/PyOctaveBand.git
cd PyOctaveBand

  2. Create a virtual environment:

    python3 -m venv .venv
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate

  3. Install dependencies: Install both production and development dependencies to run tests and linters.

    pip install -r requirements.txt
pip install -r requirements-dev.txt

✅ Code Quality Standards

We enforce strict code quality standards. Before submitting a Pull Request, please ensure your code passes the following checks:

1. Type Checking (MyPy)

We use strict type checking. Ensure no errors are reported:

mypy .

2. Linting & Formatting (Ruff)

We use ruff for fast linting and formatting.

ruff check .

3. Testing (Pytest)

Run the full test suite to ensure no regressions. We aim for 100% code coverage.

pytest tests/

To check coverage locally:

pytest --cov=src/pyoctaveband --cov-report=term-missing tests/

4. Graph Generation (Optional)

If you modify the filter logic or visualization code, please regenerate the documentation graphs to verify visual correctness:

python generate_graphs.py

🚀 How to Contribute

Reporting Bugs

If you find a bug, check the Issues. If not reported, open a new issue with:

  • Steps to reproduce
  • Expected vs Actual behavior
  • Environment details (OS, Python version)

Pull Requests

  1. Fork the repository.
  2. Create a branch for your feature (git checkout -b feature/amazing-feature).
  3. Commit your changes with clear messages.
  4. Verify your code using the commands above (pytest, mypy, ruff).
  5. Push to your fork and Open a Pull Request.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE file.