Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (26 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

32 lines (26 loc) · 1.39 KB
Raw

Contributing to vlogcut

Thanks for your interest! vlogcut is a small, focused tool; contributions that keep it that way are very welcome.

Ground rules

  • License: by submitting a contribution you agree it is licensed under the project's license, GPL-3.0 (see LICENSE).
  • Dependencies: the Python stays stdlib-only. External functionality belongs behind a subprocess boundary (like ffmpeg and whisper-cli), with graceful degradation when the tool is absent.
  • Tests: python3 tests/run_checks.py must pass. New behavior needs new checks in the same style (hand-built word lists preferred; media-gated checks must skip cleanly when tools/fixtures are unavailable).
  • Stability contracts: read docs/ARCHITECTURE.md first — words.json semantics, edit.md round-tripping, and the render-is-a-pure-function rule are load-bearing.
  • No personal data: never commit real footage, transcripts, or personal paths. Fixtures must be synthetic (see testdata/takes/).

Getting started

python3 -m pip install -e .
vlogcut setup --check          # see what your machine is missing
python3 tests/run_checks.py    # should end with ALL ... CHECKS PASSED

Bug reports with an inspect PNG and an audit excerpt are the most actionable kind. For platform reports (especially Linux), include the output of vlogcut setup --check.