Files
filmcraft/CONTRIBUTING.md
T
Brandon ThomasandClaude Opus 5.5 4e2a8077d1 docs: public architecture, contributing, testing and agent guides
Public equivalents of the maintainer-local plan/: docs/architecture.md (layers as enforced by
xtask, Tick time base, data model, command system and undo, render/playback/export pipeline,
automation surfaces), docs/contributing.md (+ root CONTRIBUTING.md), docs/testing.md and
docs/agents.md (MCP/control channel usage, agent work loop, decision rules, Definition of Done).
CLAUDE.md points at the public docs wherever it references plan/; AGENTS.md gains a See also list;
README gains a Documentation section.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-09-30 23:24:13 -04:00

762 B

Contributing to FilmCraft

Thanks for helping. Before you start:

  1. Read AGENTS.md. Its rules are absolute. In particular: no Adobe assets of any kind, every asset openly licensed with an attribution sidecar, no GPL/LGPL code, and ffmpeg only as an external test oracle.
  2. Follow docs/contributing.md: setup per OS, building and running, the quality gates (cargo xtask ci), commit conventions, and how to add commands, effects, transitions, codecs, panels and assets.

More reading: docs/architecture.md, docs/testing.md, docs/agents.md, ROADMAP.md.

Contributions are licensed under MIT OR Apache-2.0, the project licence.