Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.53 KB

File metadata and controls

33 lines (26 loc) · 1.53 KB

Contributing Guidelines(贡献守则)

基本流程

  • fork 本仓库
  • 从 master 处创建一个分支,其名称格式为 <type>/<name>。其中 <type> 为变更类型,请在下列选项中选择,而 <name> 为变更的具体内容,请使用小写字母并用 「-」 作为分隔符。例如 feature/blog-system
    • feature: 新增功能
    • bugfix: 修复 bug
    • docs: 文档等其他的相关更新
  • 在此新分支上,完成你的开发
  • 测试你开发完成的程序,并逐一检查你新增加的功能是否完整合理
  • 为你的开发添加单元测试,请保证此时,所有的单元测试均通过,且核心代码部分的单元测试覆盖率达到 80% 以上
  • 向本仓库提交 pull request,请 pull 至最新的 release 分支,而不是 master 分支
  • 等待 「我」 对你的代码进行 code review
  • 根据 code review 内的评论,解决其中所有的问题
  • 由 「我」 同意 pull request,并等待后续的测试完成后,「我」 将会把 release 代码同步至 master
  • 至此,你已经完成了整个提交流程,你可以选择删除掉 fork 的仓库或者保留它

你需要做到的任务

  • 完整地完成完整的逻辑
  • 合理解决了问题或者实现了功能
  • 拥有超过 80% 以上的单元测试覆盖

什么样的提交会一定被拒绝

  • 不符合编码规范或者原有的框架结构
  • 使用无意义的变量名
  • 没有保持代码的格式化
  • 使用不常见的解决方案或者令人难以理解的解决方案
  • 无意义的更改