Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1013 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1013 Bytes
Raw

Contributing

This is an exploratory proof-of-concept. Issues and pull requests are welcome, but please read the NOTICE first — this project is not an official SMPTE work item.

Ground rules

  • Do not contribute proprietary studio footage, paid test material, or media that cannot be publicly redistributed.
  • Do not reproduce SMPTE standards text verbatim. Reference standards by number and section.
  • Keep dependencies lean. Prefer the Node standard library and FFmpeg.

Development

npm install
npm run build
npm test
npm run typecheck

Each package has its own test script. Run them individually with npm run test --workspace=packages/core, etc.

Code style

  • TypeScript, strict mode, NodeNext modules.
  • No comments unless the why is non-obvious.
  • Tests live in <package>/test/ and use Vitest.

Sample media

The repository does not include sample IMF media. Place your own IMF package under any local path and pass it to the CLI or Electron app via flags.