Contributing to sluggi

Thank you for helping make sluggi better! We welcome all contributions—code, docs, tests, and ideas.

Getting Started

• Fork and clone the repo from blip-box/sluggi.
• Install dev dependencies: bash pip install .[dev,cli]
• Code style:
• Format code with Black
• Lint with Ruff
• Type annotations for all public APIs
• Testing:
• Run tests with pytest
• Open issues/PRs for bugs, features, or improvements.
• See our Code of Conduct and Security Policy for community and reporting guidelines.

Pull Request Checklist

• Branch from main and keep your branch up to date.
• Run all tests and linters before submitting.
• Use clear, descriptive commit messages.
• Reference related issues in your PR description.
• At least one maintainer review is required.
• Follow our Release Process for version bumps and publishing.

Code Style Guide

• Formatting: Black
• Linting: Ruff
• Type Hints: Required for all public APIs.
• Imports: Standard, third-party, then local.
• Docstrings: Concise and clear for all public functions/classes.

Pre-commit Hooks

Set up pre-commit hooks to enforce style and quality:

Install and run hooks:

pre-commit install
pre-commit run --all-files

Release Checklist

• [ ] All tests and linters pass
• [ ] Docs and Changelog updated
• [ ] Version bumped in __init__.py and pyproject.toml
• [ ] Commit with message: Release vX.Y.Z
• [ ] Push to main and create a GitHub release
• [ ] Publish to PyPI: bash python -m build twine upload dist/*
• [ ] Verify GitHub Pages documentation is up to date

Thank you for contributing! — The blipbox/sluggi team