为仓库贡献者设定指南

关于贡献指南

为了帮助您的项目贡献者做好工作，您可以在项目仓库的根目录、docs 或 .github 文件夹中添加一个包含贡献指南的文件。当有人打开拉取请求或创建议题时，他们会看到指向该文件的链接。贡献指南的链接也会出现在仓库的 contribute 页面上。有关 contribute 页面示例，请参阅 github/docs/contribute。

如果您的仓库包含 CONTRIBUTING.md 文件，GitHub 还会在另外两个位置显示该文件，以便贡献者更容易发现

一个““Contributing” 选项卡位于仓库概览（在 “README” 和 “行为准则”）
在仓库侧边栏中的 “Contributing” 链接

对于仓库所有者而言，贡献指南是一种传达人们应如何贡献的方式。

对于贡献者来说，指南帮助他们确认自己的拉取请求格式正确且议题有价值。

对于所有者和贡献者而言，贡献指南可以节省因不当创建的拉取请求或议题而导致的拒绝与重新提交所浪费的时间和麻烦。

您可以为您的组织或个人账户创建默认的贡献指南。了解更多信息，请参阅创建默认社区健康文件。

提示

仓库维护者可以通过为仓库创建议题或拉取请求模板来设定针对议题的具体指南。了解更多信息，请参阅关于议题和拉取请求模板。

添加 `CONTRIBUTING.md` 文件

在 GitHub 上，导航至仓库的主页面。
在文件列表上方，选择 添加文件下拉菜单，然后点击 创建新文件。

或者，您可以点击在左侧的文件树视图中。
决定是否将您的贡献指南存放在仓库的根目录、docs 或 .github 目录中。然后，在文件名字段中输入文件的名称和扩展名。贡献指南的文件名不区分大小写。如果文件扩展名属于受支持的格式，文件将以富文本形式渲染。了解更多信息，请参阅处理非代码文件。
- 要使您的贡献指南在仓库根目录中可见，请输入 CONTRIBUTING。
- 要使您的贡献指南在仓库的 docs 目录中可见，请输入 docs/ 来创建新目录，然后输入 CONTRIBUTING。
- 如果仓库包含多个 CONTRIBUTING 文件，则链接中显示的文件将按照以下顺序选择位置：首先是 .github 目录，其次是仓库根目录，最后是 docs 目录。
在新文件中，添加贡献指南。内容可以包括
- 创建优质议题或拉取请求的步骤。
- 指向外部文档、邮件列表或行为准则的链接。
- 社区和行为期待。
点击 提交更改...
在“Commit message”字段中，键入简短且有意义的提交信息，描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息，请参阅创建拥有多位作者的提交。
在提交信息字段下方，决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支，建议为提交创建一个新分支，然后发起拉取请求。欲了解更多信息，请参阅创建拉取请求。
点击 提交更改 或 提议更改。