跳转到内容

提交代码贡献指南

为 PlayCover 项目提交 Pull Request (PR) 时,请遵循以下规范:

仅接受对应用功能产生实际影响的代码变更,微小拼写修正等无关核心功能的提交将被拒绝。

新增功能需确保持续维护价值,避免引入非必要代码导致项目臃肿。与项目目标不符的提案将被驳回。

提交前需检查:

  • GitHub 项目看板In Progress板块
  • 现有开放状态的 PR 确保无其他贡献者正在进行相同工作

所有代码必须满足:

  • 注释与变量使用英文命名
  • 通过 SwiftLint 静态检查
  • 具备良好可读性

涉及底层 API 或复杂逻辑时,需添加详细功能说明文档。

新增用户可见文本(非日志/错误信息)需同步更新多语言文件。

PR 描述需清晰说明变更内容,涉及 UI 调整需附截图说明。

  1. Fork 项目仓库
  2. 创建功能分支:git checkout -b feature/功能名称
  3. 提交变更:git commit -m '描述性提交信息'
  4. 推送至远程:git push origin feature/功能名称
  5. 创建 Pull Request
  • 审核周期:项目维护者利用业余时间处理,可能需数日或数周,请保持耐心
  • 反馈响应:需专业礼貌地回应审核意见,违反行为准则将导致 PR 被拒
  • 贡献者权益:通过重要贡献可获 Discord Contributor 身份,访问专属讨论频道
  • 荣誉展示:所有贡献者将列名官网致谢页