Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (66 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

94 lines (66 loc) · 2.86 KB

Contributing to killpy

Thank you for wanting to improve killpy! Contributions of all kinds are welcome — bug reports, feature ideas, documentation fixes, and pull requests.

Quick start

# 1. Fork the repo on GitHub, then clone your fork
git clone https://github.com/<your-username>/killpy.git
cd killpy

# 2. Install with development dependencies (uv recommended)
pip install -e ".[dev]"
# or
uv sync

# 3. Verify everything works
python -m compileall killpy
pytest tests/

Development workflow

  1. Create a branch off master (or main): 
    git checkout -b feat/my-feature
  2. Make focused, minimal changes — avoid refactoring unrelated code.
  3. Run tests before committing: 
    pytest tests/
  4. Run the linter / type checker if available: 
    ruff check killpy
mypy killpy
  5. Write a commit message following Conventional Commits: 
    feat: add --exclude option to skip path patterns
fix: handle missing conda command gracefully
docs: update keybindings table in README
  6. Open a pull request against master with a clear description of what and why.

Adding a new detector

Detectors live in killpy/detectors/. Each one inherits from AbstractDetector in base.py.

from killpy.detectors.base import AbstractDetector
from killpy.models import Environment

class MyToolDetector(AbstractDetector):
    name = "mytool"

    def detect(self, path: Path) -> list[Environment]:
        # return a list of Environment objects
        ...

Then register it in killpy/scanner.py inside _build_detectors().

Recording a demo GIF

A compelling demo GIF is one of the best ways to showcase new features.

Recommended setup:

  • Terminal: 100 × 30 characters, dark theme
  • Tool: vhs or asciinema + agg
  • Content: show scanning, filtering with /, multi-selecting with T/Space, and deleting

Update show.gif in the repo root and reference it in README.md.

Good first issues

Look for issues labelled good first issue — these are intentionally scoped to be approachable for new contributors.

Code of conduct

Be respectful and constructive. We follow the Contributor Covenant.