Contributing¶

Thank you for your interest in contributing to pre-commit-snippets!

Development Setup¶

# Clone the repository
git clone https://github.com/RemoteRabbit/pre-commit-snippets.git
cd pre-commit-snippets

# Install dependencies and set up pre-commit hooks
make setup

Running Tests¶

make test

Running All Checks¶

make check  # lint, format, typecheck, test

Building Documentation¶

# Install docs dependencies
pip install mkdocs mkdocs-material mkdocstrings[python]

# Serve locally
make docs-serve

# Build static site
make docs-build

Conventional Commits¶

This project uses Conventional Commits for automated versioning.

Commit Types¶

Type	Description	Version Bump
`feat`	A new feature	Minor
`fix`	A bug fix	Patch
`docs`	Documentation only	None
`refactor`	Code refactoring	None
`test`	Adding tests	None
`chore`	Maintenance	None

Examples¶

feat: add support for multiple snippet repositories
fix: handle missing SNIPPET-END marker gracefully
docs: update README with configuration examples

Release Process¶

Releases are automated using Release Please.

Merge commits following Conventional Commits format
Release Please creates/updates a release PR
Merge the release PR to create a GitHub release