Implementing a new feature
We are happy to accept contributions to the Remotion project that implement new features.
See the CONTRIBUTING.md file for instructions on how to set up the project.
What's important to us
- Planning: Signal beforehand that you would like to propose the feature by opening an issue and mentioning that you would like to work on it.
This gives us the chance to comment on whether we like the feature and lets us discuss the architecture.
- Generic: The feature should be as unopinionated as possible. Instead of making decisions that are specific to your usecase, try to make the feature as generic as possible so that it can be used by everyone.
- Size: The feature should not bloat lightweight packages by adding dependencies that can be avoided. Consider if the feature should be a new package in a monorepo if there are a lot of dependencies that are not needed by everyone.
- Documentation: The feature should be documented and the documentation should have the same level of quality as the rest docs.
- TypeScript or Rust: The code should be written in one of these two languages.
- Tests: Add tests if you think it makes sense.
- Forward-compatibility: Be mindful of how the feature might evolve in the future. Using objects in the input and output of an API makes it easier to add new properties in the future.
- Backwards-compatibility: Your feature cannot break existing code if Remotion is upgraded, unless the feature lands in a major version.
- Naming conventions: Use
camelCasefor variables. If the API interfaces with numeric values, the unit should be included. For example
Remotion uses Font Awesome v5.15.4 for the icons in the Remotion Preview.
We have a license and can grant access to Pro icons if needed.
Communicate with us
#development channel on Discord to quickly ask questions and get feedback.