提交代码贡献指南
为 PlayCover 项目提交 Pull Request (PR) 时,请遵循以下规范:
1. 确保PR具有实质内容
Section titled “1. 确保PR具有实质内容”仅接受对应用功能产生实际影响的代码变更,微小拼写修正等无关核心功能的提交将被拒绝。
2. 评估功能必要性
Section titled “2. 评估功能必要性”新增功能需确保持续维护价值,避免引入非必要代码导致项目臃肿。与项目目标不符的提案将被驳回。
3. 规避重复工作
Section titled “3. 规避重复工作”提交前需检查:
- GitHub 项目看板
In Progress
板块 - 现有开放状态的 PR 确保无其他贡献者正在进行相同工作
4. 代码质量要求
Section titled “4. 代码质量要求”所有代码必须满足:
- 注释与变量使用英文命名
- 通过 SwiftLint 静态检查
- 具备良好可读性
涉及底层 API 或复杂逻辑时,需添加详细功能说明文档。
5. 国际化适配
Section titled “5. 国际化适配”新增用户可见文本(非日志/错误信息)需同步更新多语言文件。
6. 提交信息规范
Section titled “6. 提交信息规范”PR 描述需清晰说明变更内容,涉及 UI 调整需附截图说明。
- Fork 项目仓库
- 创建功能分支:
git checkout -b feature/功能名称
- 提交变更:
git commit -m '描述性提交信息'
- 推送至远程:
git push origin feature/功能名称
- 创建 Pull Request