返回
在提出 Issue 之前,请参阅此指南
前端
2024-01-26 06:08:36
Issue 的作用
Issue 是一种非常好的可沉淀的交流方式,可跟踪,可复现。我们可以使用 GitHub Issue 来与社区交流,它有几种应用场景:
- 答疑交流。 当你在使用 Egg 的过程中遇到问题时,可以创建一个 Issue 来寻求帮助。社区中的其他成员或维护者会帮助你解决问题。
- 反馈缺陷。 如果你在使用 Egg 时发现了一个缺陷,可以创建一个 Issue 来报告它。维护者会尽快修复这个缺陷。
- 提交新需求。 如果你对 Egg 有新的需求,可以创建一个 Issue 来提出它。维护者会考虑你的需求,并决定是否将其添加到 Egg 中。
如何创建一个 Issue
在 Egg 的 GitHub 仓库中,点击 “Issues” 标签,然后点击 “New issue” 按钮。在弹出的窗口中,填写以下信息:
- 标题。 标题应该简明扼要地 Issue 的内容。
- 正文。 正文中详细 Issue 的内容。你也可以在这里贴上代码片段、截图等信息。
- 标签。 给 Issue 添加标签,以便其他用户可以更容易地找到它。
- 指派人。 如果你知道哪个维护者对这个 Issue 感兴趣,可以将他们指派为负责处理。
填写完以上信息后,点击 “提交” 按钮,即可创建一个 Issue。
撰写高质量的 Issue
为了提高 Issue 的质量,请注意以下几点:
- 标题要简明扼要。 标题应该简明扼要地描述 Issue 的内容,以便其他用户可以更容易地找到它。
- 正文要详细描述 Issue 的内容。 正文中详细描述 Issue 的内容,以便其他用户可以更容易地理解它。你也可以在这里贴上代码片段、截图等信息。
- 添加标签。 给 Issue 添加标签,以便其他用户可以更容易地找到它。
- 指派人。 如果你知道哪个维护者对这个 Issue 感兴趣,可以将他们指派为负责处理。
参与 Issue 的讨论
在 Issue 创建之后,你可以参与 Issue 的讨论。你可以回复其他用户的评论,也可以添加自己的评论。在讨论中,请注意以下几点:
- 保持礼貌。 在讨论中,请保持礼貌,避免使用攻击性语言。
- 尊重其他人的意见。 即使你不同意其他人的意见,也请尊重他们的意见。
- 提供有用的信息。 在讨论中,请提供有用的信息,以便其他用户可以更好地理解 Issue 的内容。
关闭 Issue
当 Issue 被解决后,可以将其关闭。你可以通过点击 Issue 右上角的 “Close issue” 按钮来关闭它。在关闭 Issue 时,请填写以下信息:
- 关闭原因。 选择一个关闭原因,以便其他用户可以知道为什么 Issue 被关闭。
- 备注。 在备注中写上一些额外的信息,以便其他用户可以更好地理解为什么 Issue 被关闭。
填写完以上信息后,点击 “提交” 按钮,即可关闭 Issue。