Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (38 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

48 lines (38 loc) · 1.32 KB

Guidelines for contribution

  1. Clone the repository
  2. Install uv and just if you don't have them already
  3. Install the package with development dependencies: 
    uv sync --group dev
  4. Make your changes
  5. Run quality checks before committing: 
    just check        # Run all checks: lint, typecheck, test, doctest
# Or run individually:
just lint         # Check code style with ruff
just typecheck    # Type check with mypy
just test         # Run pytest
just format       # Auto-format code with ruff
just --list       # Show all available recipes
  6. Make a pull request with a clear summary of the changes

Building documentation locally

To build the docs locally, install Quarto (version is specified in the CI workflow), then:

uv sync --group docs
make docs

Running specific tests

# Run a specific test file
uv run pytest tests/test_comparer.py

# Run a specific test function
uv run pytest tests/test_comparer.py::test_function_name

# Run with coverage
just coverage

Project structure

  • Source code is in src/modelskill/
  • Tests are in tests/
  • Test data is in tests/testdata/ (symlinked as docs/data)