ISSUE提交规范

MindCV提交ISSUE规范

MindCV仓库是基于MindSpore开发的机器视觉领域套件，提交issue是向项目开发者提出改进建议或反馈问题的一种方式。如果你想在MindCV仓库中提交issue，可以遵循本教程所讲的规范进行提交。

创建ISSUE

• 进入MindCV的ISSUE提交页面，点击New issue。

• 根据要反馈的内容，选择issue模板。如果要提交问题单ISSUE，点击BUG report后的Get started按钮；如果要提交需求ISSUE，点击Feature request后的Get started按钮。

命名规范

确保issue的标题简洁明了，描述清楚问题的关键信息。

TO DO

标签规范

在提交issue时，应该为issue打上相关的标签，以便贡献者更好地理解问题所属的类别。

• 根据问题所处的阶段，选择相应的状态标签。

  • TODO：已提出，待负责人确认的issue。
  • ACCEPTED：负责人已确认，待处理的issue。
  • WIP：Work-In-Progress，正在修复中的issue。
  • VALIDATION：修复完毕，正在回归中的issue；由负责人与提单人沟通之后，选择此状态。
  • DONE：提单人验证完成，已回归通过的issue；由提单人选择此状态，代表关闭，开发不能关闭测试提的问题单。
  • REJECTED：被驳回的issue，与提单人沟通后，确认不属于问题则选择此状态来关闭issue。

• 如果是需求单，需要根据需求交付的等级，选择合适的标签。

  • stable：表示这是一个稳定的需求，可以在下一个版本中实现。
  • beta：表示这是一个比较重要的需求，但是目前还不能保证可以在下一个版本中实现。
  • demo：表示这是一个演示需求，用于演示软件的新功能。

• 根据ISSUE单的重要程度，选择合适的优先级标签。

• 另外，如果ISSUE为问题单，需要添加bug标签；如果是需求单，需要添加rfc标签。

• 如果是内部开发者提的ISSUE需要添加inside-test标签。

其他设置

责任人（Assignees）

如实选择负责人、协作人，负责人为问题单处理责任人，协助人为问题单相关责任人。

项目（Project）

选择ISSUES所对应的项目。

里程碑（Milestone)

本项目中的里程碑用户区分对应的MindCV的开发版本，根据ISSUE单对应的MindCV版本，选择相应的里程碑。

内容编写

• 如果你发现了一个错误或者缺陷，可以提交一个问题单issue，根据模板的指引，描述清楚问题的现象、复现步骤和期望结果。
• 如果你有一个新功能的建议或者对现有功能的改进意见，可以提交一个需求issue，根据模板的指引描述清楚你的建议和期望的结果。

总之，在提交issue时，应该尽量清晰明了地描述问题，并且使用适当的标签，这样开发者才能更好地理解你的意图，并给出合理的回复。