📝 GitHub Issue 提交规范

📝 GitHub Issue 提交规范

一个清晰、规范的 Issue 可以帮助维护者更快地理解问题、重现问题，并最终解决问题。

1. 标题 (Title) 🚀

• 简洁明了：用最精炼的语言描述问题或建议的核心内容。
• 概括性强：让阅读者第一眼就能明白 Issue 的主题。
• 避免空泛：不要使用 "Bug"、"问题" 等过于宽泛的词语。
• 示例：
  • ✅ "Feature Request: Add support for exporting data to CSV format"
  • ✅ "Bug: Login page crashes on iOS devices with version 14.0"
  • ❌ "Bug"
  • ❌ "Something is not working"

---

2. 内容 (Body) ✍️

• 详细描述：清晰、完整地描述你遇到的问题或提出的建议。
• 步骤重现：如果是一个 Bug，提供重现步骤，方便维护者复现问题。
• 环境信息：提供操作系统、浏览器版本、软件版本等相关环境信息。
• 期望结果：描述你期望发生的行为或结果。
• 实际结果：描述实际发生了什么，与期望结果的差异。
• 相关链接：如果与某个文档、网页或代码片段相关，提供链接。
• 错误信息：如果是错误，提供完整的错误信息（堆栈跟踪、日志等）。
• 截图/视频：如果可以，提供截图或视频，更直观地展示问题。
• 示例：

**描述**
在用户尝试登录时，应用崩溃。

**重现步骤**
1.  打开应用
2.  点击 "登录" 按钮
3.  输入用户名和密码
4.  点击 "提交"

**环境信息**
*   操作系统: iOS 14.0
*   设备: iPhone X
*   应用版本: 2.0

**期望结果**
成功登录并进入主页。

**实际结果**
应用崩溃并退出。

**错误信息**

EXC_BAD_ACCESS (SIGSEGV) ... (堆栈跟踪)

**截图**
![崩溃截图](url_to_screenshot)

---

3. 标签 (Labels) 🏷️

• 分类 Issue：使用标签对 Issue 进行分类，如 bug、feature、enhancement、question 等。
• 优先级：如果适用，使用标签标明优先级，如 high、medium、low。
• 模块/组件：使用标签标明 Issue 涉及的模块或组件。
• 示例：
  • bug, login, iOS
  • feature, export, CSV

---

4. 其他注意事项 ⚠️

• 一个 Issue 一个问题：不要在一个 Issue 中报告多个不相关的问题。
• 搜索现有 Issue：在提交之前，搜索是否已经有人报告了相同的问题。
• 保持礼貌：友善、尊重地与维护者交流。
• 及时回复：如果维护者需要更多信息，及时回复。
• 更新状态：如果问题解决或有新的进展，及时更新 Issue 状态。
• 关闭 Issue：问题解决后，关闭 Issue。
• 使用 Markdown：使用 Markdown 格式化 Issue 内容，使其更易读。

---

5. 模板 (Template) 📄

示例：bug_report.md

---
name: Bug Report
about: Report a bug in the project
title: "[BUG] - "
labels: bug
assignees: ''

---

**描述**
请清晰、完整地描述你遇到的问题。

**重现步骤**
请提供重现问题的步骤：
1.  ...
2.  ...
3.  ...

**环境信息**
*   操作系统: [e.g. iOS, Android, Windows, macOS, Linux]
*   浏览器: [e.g. Chrome, Safari, Firefox]
*   版本: [e.g. 22]

**期望结果**
请描述你期望发生的结果。

**实际结果**
请描述实际发生的结果。

**错误信息**
请提供完整的错误信息（堆栈跟踪、日志等）。

**截图**
请提供截图，更直观地展示问题。