# 参与贡献 感谢你愿意改进 Caplo。缺陷修复、体验打磨、翻译校对和文档补充都非常欢迎。 ## 开始之前 - **缺陷**:先搜一下 [Issues](https://github.com/icloudza/caplo/issues) 是否已有人报告,没有再按模板提交。 - **新功能或较大的改动**:请先开 Issue 说明想法,确认方向后再动手,避免白费功夫。 - **小改动**(错别字、文案、明显的小缺陷)可以直接提 PR。 ## 本地开发 需要 macOS 15 及以上、Xcode 16 及以上。构建步骤见 [README](README.md#构建)。 Xcode 运行的调试版名为 Caplo Dev(`com.caplo.app.dev`),权限、设置与工程库都与正式版分开,可以放心和正式版同时使用。 ## 提交前 在仓库根目录跑一遍整体检查(单元测试、颜色令牌、窗口回归、构建): ```bash Scripts/check.sh ``` 改了界面文字时,同步翻译目录并补上英文: ```bash Scripts/localize.sh ``` ## 代码约定 - **界面文字**:写在 `Text` / `Button` 里的字面量会自动本地化;其余显示文字用 `String(localized:)`。会存进工程文件的值(枚举原始值、预设名)不要翻译,另加 `title` 显示。 - **颜色**:业务界面只用 `CaploColor` 令牌,不直接写颜色字面量。 - **测试**:修缺陷时尽量在现有测试里补一条能复现它的断言,并确认撤掉修复后它会失败。 - **界面改动**:在 PR 里附上改动前后的截图。 ## 提交 PR - 一个 PR 只做一件事,标题直接说明改了什么。 - 按模板填写改动说明与验证方式,关联对应的 Issue。 - 维护者会尽快审阅;需要调整时会在 PR 里留言。 ## 贡献授权 Caplo 以 [PolyForm Noncommercial 1.0.0](LICENSE) 授权,同时由维护者另行提供商业授权。提交贡献即表示: - 贡献内容是你本人的作品,或你有权以下述方式提交; - 你同意贡献以本项目的许可证授权,并授予维护者(cloudza)将其纳入其他授权条款(包括商业授权)再行许可的权利。 如果不能接受以上条款,请不要提交代码,可以通过 Issue 描述问题或建议。