Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (72 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

112 lines (72 loc) · 2.68 KB
Raw

Contributing to SUPERVAIZER

Thank you for considering contributing to SUPERVAIZER! This document outlines the development process and guidelines.

Development Environment

This project uses just as a command runner. Here are the available commands:

just -l

Setup Development Environment

  1. Clone the repository
  2. Install uv: pip install uv
  3. Create and activate a virtual environment:
    • uv venv
    • Windows: .venv\Scripts\activate
    • Unix/MacOS: source .venv/bin/activate
  4. Install development dependencies: just install-dev
  5. Install Git hooks: just install-hooks

Running Tests

pytest

Or for specific test categories:

pytest -m "not slow"  # Skip slow tests
pytest -m "current"   # Run tests under development

Running tests without test coverage:

just test-no-cov

Rerunning failed tests:

just test-failed

Type checking

Running mypy directly:

mypy supervaizer

Running mypy for all (including tests):

mypy supervaizer tests

Running mypy via pre-commit:

just mypy

Pull Request Process

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the tests to ensure they pass
  5. Update documentation as needed
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Code Style

We follow PEP 8 with a line length of 120 characters. The project uses the following tools for code quality:

  • Ruff for code formatting, linting and import sorting
  • Mypy for type checking

All of these are run as pre-commit hooks, so make sure you install them as mentioned above.

🔐 Licensing and Contribution Terms

By submitting a contribution (code, documentation, or other content) to this project, you agree to license it under the terms of the Mozilla Public License 2.0 (MPL-2.0).

You retain the copyright to your contribution, but you grant the project maintainers and all users the right to use, modify, and distribute it as part of the project under the MPL-2.0 license.

This project uses the Developer Certificate of Origin (DCO) to ensure that contributions are made with clear rights. By submitting a contribution, you certify that:

“I certify that the contribution was created in whole or in part by me and I have the right to submit it under the MPL-2.0 license.”

You express this certification by signing off each commit using the -s flag in git commit:

Example:

git commit -s -m "Fix bug in data sync logic"

Contributions without this sign-off may be rejected.

⸻