关于贡献指南
为了帮助您的项目贡献者做好工作，您可以将包含贡献指南的文件添加到项目代码库的根目录、docs 或 .github 文件夹中。当有人打开拉取请求或创建问题时，他们会看到指向该文件的链接。贡献指南的链接也会显示在您的代码库的 contribute 页面上。有关 contribute 页面的示例，请参阅 github/docs/contribute。
对于代码库所有者，贡献指南是传达人们如何做出贡献的一种方式。
对于贡献者，指南帮助他们验证他们是否提交了格式良好的拉取请求并打开了有用的问题。
对于所有者和贡献者来说，贡献指南可以节省因创建不当的拉取请求或必须拒绝并重新提交的问题而导致的时间和麻烦。
您可以为您的组织或个人帐户创建默认的贡献指南。有关更多信息，请参阅“创建默认社区健康文件”。
提示
代码库维护者可以通过为代码库创建问题或拉取请求模板来设置特定问题指南。有关更多信息，请参阅“关于问题和拉取请求模板”。
添加 CONTRIBUTING 文件
-
在 GitHub 上，导航到代码库的主页。
-
在文件列表上方，选择**添加文件**下拉菜单，然后单击 创建新文件.
或者，您可以单击左侧的文件树视图中的。
-
决定是否将您的贡献指南存储在代码库的根目录、
docs或.github目录中。然后，在文件名字段中，键入文件的名称和扩展名。贡献指南文件名不区分大小写。如果文件扩展名采用受支持的格式，则文件将以富文本格式呈现。有关更多信息，请参阅“使用非代码文件”。- 要使您的贡献指南在代码库的根目录中可见，请键入 CONTRIBUTING。
- 要使您的贡献指南在代码库的
docs目录中可见，请键入 docs/ 以创建新目录，然后键入 CONTRIBUTING。 - 如果代码库包含多个 CONTRIBUTING 文件，则链接中显示的文件将按以下顺序从以下位置选择：
.github目录、代码库的根目录，最后是docs目录。
-
在新文件中，添加贡献指南。这些可能包括
- 创建良好问题或拉取请求的步骤。
- 指向外部文档、邮件列表或行为准则的链接。
- 社区和行为期望。
-
单击**提交更改...**
-
在“提交消息”字段中，键入简短且有意义的提交消息，描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息，请参阅“使用多个作者创建提交”。
-
在提交消息字段下方，决定是否将您的提交添加到当前分支或新分支。如果您的当前分支是默认分支，则应选择为您的提交创建新分支，然后创建拉取请求。有关更多信息，请参阅“创建拉取请求”。
-
单击**提交更改**或**提出更改**。
贡献指南示例
如果您感到困惑，以下是一些优秀的贡献指南示例