Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (26 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.04 KB
Raw

Contributing

Thanks for helping improve Timelapse Maker.

Setup

Install GTK 4, libadwaita, PyGObject, FFmpeg, and pytest through your system package manager. Optional monitoring support uses psutil.

Run the app from source:

python -m timelapse_maker.app

Run checks:

python -m compileall timelapse_maker
pytest

Code Guidelines

  • Prefer changes in timelapse_maker/; legacy PyQt files are kept only as migration reference.
  • Keep engine behavior testable without launching GTK.
  • Keep FFmpeg command construction in timelapse_maker.engine.
  • Keep subprocess progress and cancellation in timelapse_maker.runner.
  • Avoid adding dependencies unless they remove more complexity than they add.

Docs Guidelines

Update README and docs when user-visible behavior changes. Packaging changes should update docs/PACKAGING.md.

Pull Request Checklist

  • Tests pass.
  • The app still launches from source.
  • New sequence detection or FFmpeg behavior has a small test.
  • README or docs are updated for user-visible changes.