🧩 Contributing Guide

Thanks for your interest in contributing to Apathetic Python Utils — a collection of utility functions for Apathetic Tools projects.

For detailed information on setting up your environment, running checks, and contributing code, please visit our documentation website.

This file provides a quick reference for common development tasks.

Quick Reference

Command	Description
`poetry run poe check:fix`	Auto-fix issues, re-format, type-check, and re-test.
`poetry run poe check`	Run linting (`ruff`), type checks (`mypy`), and tests (`pytest`).
`poetry run poe fix`	Run all auto-fixers (`ruff`).
`poetry run poe build:stitched`	Bundle the project into a single portable script in `dist/`.

# Install dependencies
poetry install --with dev

# Run checks before committing
poetry run poe check:fix

Follow PEP 8 (enforced via Ruff).
Keep the core library dependency-free — dev tooling lives only in pyproject.toml's dev group.
Run poetry run poe check before committing.
Open PRs against the main branch.
Be kind: small tools should have small egos.

Thank you for helping keep Apathetic Python Utils minimal, dependency-free, and delightful.