Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
18 lines (13 loc) · 903 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 903 Bytes

Porting Notes

This fork is the active macOS/Apple Silicon port of the upstream open-capture stack.

Branch naming

  • Use the codex/ prefix for implementation branches.
  • Prefer names in the shape codex/<area>-<task>, for example codex/macos-capture-app or codex/mlx-frame-conversion.

Working rules

  • Work TODO.md from top to bottom unless connected hardware disproves the current sequence.
  • Keep the public VideoCapture and SensorCapture API shape stable unless a hard macOS constraint forces a change.
  • Keep Linux code paths building while adding the macOS backend.
  • Prefer explicit capability-gated failures over silent no-ops or compile-time crashes.
  • Keep raw capture bring-up separate from MLX compute work.
  • Update references/progress_log.md after every meaningful milestone.
  • Do not seed zed-ros2-wrapper-mlx until raw video, sensors, and sync are stable here.