我应该如何为问题提供指导? (Github)

How should I provide guidelines for issues? (Github)

我想为我的存储库的用户提供一些信息,说明他们应该如何报告问题以及他们应该提供哪些信息。 提供此信息的最佳方式是什么,在哪里? 我希望 /issues 选项卡上有自述文件,但似乎没有这样的选项。也许我应该创建一个名为 'Read before creating issue'?

的 'issue'

我不确定 github 是否专门提供任何此类功能。或者,您可以在项目主分支的 readme.md 文件中包含指南(或 link 如何创建问题)(例如 #HowToCreateAnIssue 部分以及其他部分)。至少,这是我遵循的。

对于我的项目(我想这就是大多数人处理它的方式),我在项目存储库中添加了一个自述文件,并为最重要的 wiki 页面创建了一个 link。 wiki 将作为附加存储库进行管理,并提供存储信息和按需更新的可能性。 如果您还创建了一个网页,这也可以是添加一些关于如何作为贡献者参与的信息的地方。

如果您担心项目的根目录会变得混乱。
您可以将 CONTRIBUTING.mdISSUE_TEMPLATE.mdPULL_REQUEST_TEMPLATE.md 文件放在项目目录中。
是的,双方都可以轻松创建问题或拉取请求填写所有信息。

What is the best way to present this information, and where?

把它放到你的这三个文件中,文件名要和这里一样。 More information about it