Add a new effect to @remotion/effects, including implementation, package exports, docs, demos, preview images, tests, formatting, and builds.
Update `AvailableFrom` in a PR to the next Remotion patch version (`main` + `0.0.1`).
Add a new Remotion CLI or config option by creating an AnyRemotionOption, registering CLI parsing, wiring config setters, and updating documentation. Use when adding or converting command-line flags or Remotion options.
Add a new package to the Remotion monorepo, including package scaffolding, monorepo registration, documentation, build scripts, tests, and release checklist updates. Use when creating a new @remotion package.
Guidance for working on Remotion Studio Visual Mode, sequence identity, node paths, symbolicated stacks, override IDs, and hot reload behavior. Use when implementing or debugging visual editing of Sequences.
Best practices for Remotion - Video creation in React
| name | pr |
| description | Open a pull request for the current feature |
Ensure we are not on the main branch, make a branch if necessary.
For all packages affected, run Oxfmt to format the code:
bunx oxfmt src --write
Then run
bun run build
bun run formatting
to ensure we compile.
Commit the changes. The title of the PR must be according to the pr-name skill.
Push the changes to the remote branch.
Use the gh CLI to create a pull request and use the same format as above for the title.
When creating the PR, do not pass the PR body inline through a shell command (for example, avoid --body "..." or heredocs in bash). Instead:
/tmp/remotion-pr-body.md, or a unique file created under /tmp).gh pr create --title "<title>" --body-file <path-to-temp-md-file>.Example:
gh pr create --title '`@remotion/package`: Add feature' --body-file /tmp/remotion-pr-body.md