Skip to main content

实现新功能

设置

请查看 CONTRIBUTING.md 文件,了解如何设置项目。

我们重视的事项

  • 规划:事先发出信号,表示您想提出该功能,可以通过开启一个问题并提及您想要处理它来实现。
    这样我们有机会评论我们是否喜欢该功能,并让我们讨论架构。
  • 通用性:功能应尽可能不带有主观意见。请尽量使决策不针对您的用例,而是尽可能使功能通用,以便每个人都可以使用。
  • 大小:功能不应通过添加可避免的依赖项来使轻量级包变得臃肿。如果有很多不是每个人都需要的依赖项,考虑将该功能作为单体库中的新包。
  • 文档:功能应有文档,并且文档质量应与其他文档相同。

技术标准

  • TypeScript 或 Rust:代码应使用这两种语言之一编写。
  • 测试:如果有意义,请添加测试。
  • 向前兼容性:请考虑功能在未来可能如何发展。在 API 的输入和输出中使用对象可以更容易地在未来添加新属性。
  • 向后兼容性:除非该功能进入主要版本,否则您的功能不能破坏现有代码,如果 Remotion 升级。
  • 命名约定:变量应使用 camelCase。如果 API 与数值值交互,则应包含单位。例如,使用 durationInFrames 而不是 durationtimeoutInMilliseconds 而不是 timeout

图标

Remotion 在 Remotion Studio 中使用 Font Awesome v5.15.4 提供的图标。

我们有许可证,如果需要,可以授予对专业图标的访问权限。

与我们联系

使用 Discord 上的 #development 频道快速提出问题并获得反馈。

另请参阅