Skip to content
This repository has been archived by the owner on Jul 6, 2021. It is now read-only.

Latest commit

 

History

History
27 lines (14 loc) · 1.45 KB

github_issue.md

File metadata and controls

27 lines (14 loc) · 1.45 KB

GitHub: Issue

在 GitHub 中,Issue 是一个让大家针对某一个项目进行讨论和反馈的方式。

进入 Issues 的按钮位于 CodePull Requests 按钮的中间;或许在某些项目下你会找不到 Issues 这个按钮,因为项目已经关闭了 Issue 功能

JbjJun.png

点进去之后你可以看到别人发起的讨论,当然,你自己也可以通过点击 New Issue 来发起问题

JbvaqI.png

编辑标题和详细内容即可,编辑器支持 Markdown 语法

如果你要在这个 Issue 中提到某位用户,可以使用 @ 来提及用户;如果你想提及某次 Pull Requests 或者 Issues,你可以用 # 来提及

有一些大型项目为了更好的维护和接收来自用户的反馈与建议,他们会设立一些 Issue 模板

例如 FaceBook 开源的 Pytorch

JbxQyj.png

你可以根据不同的需要来开启不同的 Issue 模板,Issue 模板会内嵌许多的内容来引导你输入对他们有帮助的信息

如果没有你想发起的 Issue 模板,依然可以点击 Open a blank issue 来发起自定义的 Issue

虽然说 Issue 是一个公共区域,但是在询问问题或者汇报问题中尽量理清思路,并且尽可能给予开发者许多有用的信息。否则你发起的 Issue 很可能会因为别人看不顺眼而遭到关闭