Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
51 lines (39 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
51 lines (39 loc) · 1.28 KB

Contributing to KillerTools

Thanks for helping improve KillerTools!

Code of Conduct

Please read and follow our CODE_OF_CONDUCT.md.

Development Setup

# Clone
git clone https://github.com/VoxHash/KillerTools.git
cd KillerTools

# Install deps
poetry install
poetry install --with dev

# Set up pre-commit hooks
poetry run pre-commit install

# Run tests
poetry run pytest

Branching & Commit Style

  • Branches: feature/…, fix/…, docs/…, chore/…
  • Conventional Commits: feat:, fix:, docs:, refactor:, test:, chore:

Code Quality

Before committing, run:

poetry run ruff check --fix killer_tools/ apps/ tests/
poetry run black killer_tools/ apps/ tests/
poetry run isort killer_tools/ apps/ tests/
poetry run mypy killer_tools/ apps/

Pull Requests

  • Link related issues, add tests, update docs
  • Follow the PR template
  • Keep diffs focused
  • Ensure all tests pass

Creating Plugins

See docs/creating-plugins.md for detailed plugin development guide.

Release Process

For more details, see the full Contributing Guide.