GitHub 设置仓库参与者指南

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

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

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

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

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

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

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

添加 CONTRIBUTING 文件

1. 在 GitHub 上，导航到仓库的主页面。

1. 在文件列表上方，使用 Add file 下拉菜单，点击Create new file。

1. 决定是在仓库的根目录 docs 还是 .github 目录中存储您的参与指南。 然后，在文件名字段中，输入文件的名称和扩展名。 参与指南文件名不区分大小写，并且具有 .md 或 .txt 等扩展名。

• 要使您的参与指南在仓库的根目录中显示，请输入 CONTRIBUTING。
• 要使您的参与指南在仓库的 docs 目录中显示，请输入 docs/ 以创建新目录，然后再输入 CONTRIBUTING。

1. 在新文件中，添加参与指南。 这些可能包括：

• 创建良好议题或拉取请求的步骤。
• 指向外部文档、邮件列表或行为准则的链接。
• 社区和行为预期。

1. 在页面底部，输入一条简短、有意义的提交消息，描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。

1. 在提交消息字段下面，确定是要将提交添加到当前分支还是新分支。如果当前分支是默认分支，则应选择为提交创建一个新分支，然后创建一个拉取请求。更多信息请参阅“创建新的拉取请求”。

1. 单击 Propose new file（提议新文件）。

参与指南示例

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

• Atom 编辑器参与指南。
• Ruby on Rails 参与指南。
• Open Government 参与指南。

延伸阅读

• 开源指南的“启动开源项目”部分
• GitHub Learning Lab
• "添加许可到仓库"