MindCV贡献指南

MindCV贡献指南

MindCV欢迎包括提交issue和pr等在内的任何形式的贡献，下面是向MindCV贡献所需要遵循的规则，供用户参考。

准备

• 访问MindCV代码仓主页，点击Fork，fork该代码仓。
  

• 阅读MindCV主仓README，了解MindCV的功能和使用方法，并依据MindCV仓的要求对MindCV做出改进，更多要求可以参见CONTRIBUTING.md。

提交ISSUE

在开始对MindCV做出改进前，应先根据模板提交相应的issue。

1. 点击New issue按钮，新建issue。
   

2. 根据要反映的问题的类型选择相应的模板。
   

3. 如果要发现MindCV存在Bug，选择Bug反馈，根据模板填写相应的内容。将Bug出现的环境，模式，复现的步骤，Bug的日志，预期结果描述清楚，然后点击Submit new issue提交issue。
   

4. 如果要为MindCV增加新的功能和特性，选择需求特性反馈，将需求要解决的问题，解决方案，备选方案和环境要求说明清楚，然后点击Submit new issue提交issue。
   

提交PR

请按照CONTRIBUTING.md中的要求对MindCV进行改进，并将修改后的代码上传到用户之前fork的个人仓，并在个人仓中提起PR。

1. 进入个人仓，并点击Pull requests。
   
2. 点击New pull request，创建新的PR。
   
3. 选择要合入的官方仓库和分支，以及待合入的个人仓库和分支，点击Create pull request创建PR。
   

注：一个PR只能对应一个commit，如果PR中包含多次commit需要将commit压缩为一次。

4. 编写PR标题，简要描述PR所作的改动，点击Create pull request创建PR。
   

5. 进入刚提交的PR页面，设置其他内容。

   • 点击Reviewers的设置按钮，指定1名或多名审查者。
     
   • 选择1名或多名责任人（一般指定自己）。
     
   • 选择所需标签，一般要指定PR是解决Bug（bug）/增加新特定（enhancement），交付的等级（level），目前的状态（status），解决的优先级（priority）。
     
   • 选择PR所属的项目。
     
   • 选择PR的里程碑。
     
   • 关联相关issue。
     

6. 至此PR创建完成，等待门禁，如果门禁未通过，需要根据告警内容对代码进行修改并将修改后的代码上传至个人仓，直到门禁通过。门禁通过后可以联系reviewers审核代码。如果reviewers审核无误，会合入用户的PR。如果该PR已解决关联的issue，还应将关联的issue进行关闭。