开始之前

开始之前#

感谢你愿意为 Godot-FmodPlayer 贡献内容。无论是修文档、补示例、提交 Bug 复现，还是改进插件源码，都建议先花一点时间确认变更范围。

提交前建议#

  • 先检查现有 Issue、讨论和 Pull Request，避免重复工作。

  • 尽量让一个 Pull Request 只解决一个问题。

  • 优先提交小而清晰的改动，避免把功能、重构、格式化和文档修改混在一起。

  • 如果修改会影响用户行为，请补充说明、示例或测试方式。

  • 如果不确定实现方向，可以先提交草稿 PR，或在 Issue 中说明你的思路。

适合贡献的内容#

  • 修正文档中的错别字、失效链接和不清楚的说明。

  • 补充 GDScript 示例、常见用法和故障排查。

  • 修复插件在特定平台、导出流程或音频格式上的问题。

  • 改进 API 绑定、编辑器体验、导入器和总线同步逻辑。

  • 帮助维护英文翻译和术语一致性。

不建议一次性提交的内容#

  • 大规模格式化整个仓库。

  • 同时修改多个无关模块。

  • 没有说明原因的接口改名或行为变化。

  • 直接提交 FMOD 运行库文件。

FMOD Engine 受 Firelight Technologies Pty Ltd 的许可约束。插件仓库不会包含 FMOD 运行库，贡献时也不要把 fmod.dll、libfmod.so、fmod.jar 等文件提交到仓库。

如果你只是想先试一试，可以从文档的小修小补开始。这类改动最容易审查，也最容易帮助后来的使用者。