56 lines (41 loc) · 894 Bytes

Contributing to My Package

Development Setup

Clone the repository:

git clone https://github.com/ML4GW/my-package
cd my-package

Install with development dependencies using uv:
```
uv sync --group dev
```
Install pre-commit hooks:
```
uv run prek install
```

Running Tests

uv run pytest

Linting and Formatting

Run all pre-commit hooks manually:

uvx prek run --all-files

Or run ruff directly:

uv run ruff check --fix .
uv run ruff format .

Type Checking (optional)

uv run ty check src/

Building Documentation

uv sync --group docs
uv run sphinx-build -b html docs docs/_build/html

Pull Request Process

Open a PR against main with a clear description of the change
Ensure CI passes before requesting review