issue提交规范

[miojo-ca]

在Git中提交issue时，遵循一致的规范能够提高团队合作效率。通常采用的规范包括：

提交前（Before Committing)

• 确保google不能解决你的问题
• 确保已有的issue不能解决你的问题

标题（Title）：

• 简明扼要：清晰描述问题或建议的核心内容。
• 使用关键词：在标题中包含关键词，有助于快速理解问题类型或内容。

内容（Content）：

• 问题描述：详细描述问题，包括复现步骤、期望结果和实际结果。
• 环境信息：提供操作系统、软件版本等相关环境信息。
• 截图或录像：如果可能的话，附上相关截图或录像来更清晰地展示问题。

标签（Labels）：

• 分类标签：使用标签对issue进行分类，比如bug、feature、enhancement等。
• 优先级标签：根据问题的紧急程度添加优先级标签，比如critical、high、medium、low等。

评论（Comments）：

• 交流和反馈：与其他贡献者或团队成员进行交流和反馈，确保问题或建议得到充分讨论和解决。

参考链接（References）：

• 关联问题或PR：在issue中引用相关的问题或Pull Request，以便建立联系和跟踪解决进度。
• 相关文档：提供任何相关的文档或资料，有助于更好地理解和解决问题。

解决方案（Solutions）：

• 讨论解决方案：与团队一起探讨解决问题的方案，可以在issue中进行讨论和提出建议。
• 关联修复：如果有相关的修复方案或解决方法，可以在issue中引用或关联。

以上是一般常见的Git提交issue的规范，具体团队或项目也可能会根据需要添加额外的规范。重要的是保持一致性和清晰度，这有助于更高效地解决问题和推动项目进展。