设置仓库参与者指南

本文内容

• 添加 CONTRIBUTING 文件
• 参与指南示例
• 延伸阅读

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

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

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

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

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

添加 CONTRIBUTING 文件

1. On GitHub, navigate to the main page of the repository.

2. Above the file list, click Create new file.

   

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

   
   • 要使您的参与指南在仓库的根目录中显示，请输入 CONTRIBUTING。
   • To make your contributing guidelines visible in the repository's docs directory, type docs/ to create the new directory, then CONTRIBUTING.

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

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

5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

   

6. 在提交消息字段下面，确定是要将提交添加到当前分支还是新分支。 If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

   

7. Click Propose new file.

   

参与指南示例

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

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

延伸阅读

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