👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Learn more on the GitHub blog.


我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2020-08-20. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

文章版本: Enterprise Server 2.18

设置仓库参与者指南

您可以创建告知人们应如何参与您的项目的指南。

本文内容

为帮助项目参与者做好工作,您可以将含有参与指南的文件添加到项目仓库的根目录 docs.github 文件夹。 有人打开拉取请求或创建议题时,他们将看到指向该文件的链接。

参与指南

对于仓库所有者,参与指南是告知人们应如何参与的一种途径。

对于参与者,该指南帮助他们确认其提交格式规范的拉取请求和打开有用的议题。

对于所有者和参与者来说,参与指南节省了由于不正确创建必须拒绝和重新提交的拉取请求或议题而导致的时间和麻烦。

您可以为组织创建默认的参与指南。 更多信息请参阅“创建默认社区健康文件”。

提示:仓库维护员可以通过为仓库创建议题或拉取请求模板来设置议题的特定指南。 更多信息请参阅“关于议题和拉取请求模板”。

添加 CONTRIBUTING 文件

  1. 在 GitHub Enterprise 上,导航到仓库的主页面。
  2. 在文件列表上方,单击 Create new file(创建新文件)
    新文件按钮
  3. 决定是在仓库的根目录 docs 还是 .github 目录中存储您的参与指南。 然后,在文件名字段中,输入文件的名称和扩展名。 参与指南文件名不区分大小写,并且具有 .md.txt 等扩展名。
    新文件名
    • 要使您的参与指南在仓库的根目录中显示,请输入 CONTRIBUTING
    • 要使您的参与指南在仓库的 docs 目录中显示,请输入 docs/ 以创建新目录,然后再输入 CONTRIBUTING
  4. 在新文件中,添加参与指南。 这些可能包括:
    • 创建良好议题或拉取请求的步骤。
    • 指向外部文档、邮件列表或行为准则的链接。
    • 社区和行为预期。
  5. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。
    有关更改的提交消息
  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是 master,则应选择为提交创建新分支,然后创建拉取请求。 更多信息请参阅“创建新的拉取请求”。
    提交分支选项
  7. 单击 Propose new file(提议新文件)
    提议新文件按钮

参与指南示例

如果您觉得难以着手,以下是参与指南的一些良好示例:

延伸阅读

问问别人

找不到要找的内容?

联系我们