Contributing

Contributions are welcome. Below is what you need to get started.

Setting Up

1. Install with dev dependencies

   uv sync --all-groups

2. Install the pre-commit hooks

   uvx prek install

3. Happy Coding!

Tools

Tool	Purpose	Command
Ruff	Linting & Formatting	uv run ruff check .
Mypy	Type Checking	uv run mypy .
Pytest	Testing	uv run pytest
Prek	Git Hooks	uvx prek run --all-files

Commit Guidelines

We prefer (don’t require) conventional commits:

git commit -m "feat: add new selector discovery feature"
git commit -m "fix: handle missing author tags"
git commit -m "docs: update README with examples"

Commit types: feat, fix, docs, refactor, test, chore

Pull Request Guidelines

When opening a PR, please include:

1. Intent — what the PR does and why.
2. Changes — a summary of what was changed.
3. GenAI usage — if you used AI to write any of the code, include the prompts you used.
4. Risks — any risks or side effects this PR might introduce.
5. Docs — if needed, there should be a related PR to the docs repository

---

Core Maintainers

Name	Affiliation
Andrew Berg	College of Charleston, Cascading Labs
Houston Miles	College of Charleston, Cascading Labs

Cascading Labs Members

Name	Affiliation
Braeden Mefford	College of Charleston, Cascading Labs
Mia Wang	College of Charleston, Cascading Labs