我该如何提供问题指南？ （Github上）

Question

我想向我的存储库用户提供一些信息，说明他们应该如何报告问题以及应该提供哪些信息。 提供此信息的最佳方式是什么？在哪里？我希望/issues标签上有自述文件，但似乎没有这样的选项。也许我应该创造一个问题＆＃39;命名＆＃39;在创建问题之前阅读＆＃39;？

Answer 1

如果您担心项目根目录中增加的混乱。
 您可以将CONTRIBUTING.md，ISSUE_TEMPLATE.md和PULL_REQUEST_TEMPLATE.md文件放在项目目录中。
是的，双方都可以轻松创建问题或拉取请求填写所有信息。

  

提供此信息的最佳方式是什么？在哪里？

将它放入这三个文件中，文件名应与此处相同。 More information about it

Answer 2

我不确定github是否只提供任何此类功能。或者，您可以在项目主分支的readme.md文件中包含指南（或链接到如何创建问题）（例如，#HowToCreateAnIssue以及其他部分）。至少，这就是我所遵循的。

Answer 3

对于我的项目（我猜这是大多数人将如何处理它）我在自己的项目库中添加了一个自述文件，并创建了一个指向最重要的维基页面的链接。维基将作为附加存储库进行管理，并提供根据需要存储信息和更新的可能性。 如果您还创建了一个网页，这也可以添加一些关于如何作为贡献者参与的信息。