Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-09-28. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

设置仓库参与者指南

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

关于参与指南

为帮助项目参与者做好工作,可以将含有参与指南的文件添加到项目存储库的根目录、docs.github 文件夹。 有人打开拉取请求或创建议题时,他们将看到指向该文件的链接。 参与指南的链接也会出现在存储库的 contribute 页。 有关 contribute 页面的示例,请参阅 github/docs/contribute

参与指南

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

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

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

可以为组织或个人帐户创建默认贡献指南。 有关详细信息,请参阅创建默认社区运行状况文件

提示:存储库维护员可以通过为存储库创建问题或拉取请求模板来设置问题的特定指南。 有关详细信息,请参阅“关于问题和拉取请求模板”。

添加 CONTRIBUTING 文件

  1. 在 your GitHub Enterprise Server instance 上,导航到存储库的主页。 1. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。 “添加文件”下拉列表中的“创建新文件”
  2. 决定是在存储库的根目录、docs 还是 .github 目录中存储你的参与指南。 然后,在文件名字段中,输入文件的名称和扩展名。 参与指南文件名不区分大小写。 如果文件扩展名为支持的格式,文件会以富文本格式呈现。 有关详细信息,请参阅“使用非代码文件”。 “新文件名”
    • 要使参与指南在存储库的根目录中显示,请键入“CONTRIBUTING”。
    • 要使参与指南在存储库的 docs 目录中可见,请键入“docs/”以创建新目录,然后键入“CONTRIBUTING” 。
    • 如果存储库包含多个 CONTRIBUTING 文件,则按以下顺序从各位置中选择链接中显示的文件:.github 目录,然后是存储库的根目录,最后是 docs 目录。
  3. 在新文件中,添加参与指南。 这些可能包括:
    • 创建良好议题或拉取请求的步骤。
    • 指向外部文档、邮件列表或行为准则的链接。
    • 社区和行为预期。
  4. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息 1. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 1. 单击“提供新文件”。 “提供新文件”按钮

参与指南示例

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

延伸阅读