默认的社区健康文件是一组预定义的文件,为维护健康和协作的开源项目提供指导和模板。您可以将默认社区健康文件添加到名为.github文件
,在存储库的根目录中或在文档
或.github文件
文件夹。这些文件帮助您自动化和标准化项目开发和社区交互的各个方面。它们对于促进开源项目中的透明度、良好实践和协作至关重要。
GitHub将使用并显示帐户拥有的任何存储库的默认文件,该存储库在以下任何位置都没有自己的该类型文件:
- 存储库的根
- 这个
.github文件
文件夹
- 这个
文档
文件夹
例如,在没有自己的CONTRIBUTING文件的存储库中创建问题或拉取请求的任何人都会看到默认CONTRIBITING文件链接。如果存储库自己有任何文件.github/发布_模板
文件夹,包括问题模板或配置.yml文件,没有默认的内容.github/发布_模板
将使用文件夹。
默认文件不会出现在文件浏览器或Git历史记录中,也不会包含在单个存储库的克隆、包或下载中,因为它们只存储在.github文件
存储库。
作为存储库维护者,您可以使用社区标准检查表来查看您的项目是否符合推荐的社区标准,以帮助人们使用您的项目并为其做出贡献。有关详细信息,请参阅“关于公共存储库的社区配置文件."
您可以在组织或个人帐户中为以下社区健康文件创建默认值:
社区健康档案 | 描述 |
---|
代码_ OF_ CONDUCT.md | CODE_OF_CONDUCT文件定义了如何参与社区的标准。有关详细信息,请参阅“为项目添加行为准则." |
贡献.md | CONTRIBUTING文件传达了人们应该如何为您的项目做出贡献。有关详细信息,请参阅“为存储库贡献者设置指导原则." |
讨论类别表单 | 讨论类别表单自定义可供社区成员在存储库中打开新讨论时使用的模板。有关详细信息,请参阅“创建讨论类别表单." |
资金.yml | FUNDING文件在存储库中显示赞助商按钮,以增加开放源码项目的资金选项的可见性。有关详细信息,请参阅“在存储库中显示赞助商按钮." |
GOVERNANCE.md公司 | GOVERNANCE文件可以让人们了解您的项目是如何管理的。例如,它可能会讨论项目角色以及如何做出决策。 |
发布和拉取请求模板以及配置.yml | 发布和拉取请求模板自定义和标准化了您希望贡献者在存储库中打开问题和拉取要求时包含的信息。有关详细信息,请参阅“关于发布和拉取请求模板." |
安全.md | SECURITY文件提供了有关如何报告项目中的安全漏洞以及超链接该文件的说明。有关详细信息,请参阅“将安全策略添加到存储库." |
支架.md | 支持文件让人们了解获得项目帮助的方法。有关详细信息,请参阅“向项目中添加支持资源." |
无法创建默认许可文件。必须将许可证文件添加到各个存储库中,以便在克隆、打包或下载项目时包含该文件。
-
在任何页面的右上角,选择,然后单击新建存储库.
-
使用所有者下拉菜单,然后选择要为其创建默认文件的组织或个人帐户。
-
在“Repository name”字段中,键入.github文件.
-
(可选)在“描述”字段中键入描述。
-
确保存储库状态设置为公共。默认文件的存储库不能是专用的。
-
选择使用README初始化此存储库.
-
点击创建存储库.
-
在存储库中,创建一个受支持的社区健康文件。问题模板及其配置文件必须位于名为.github/发布_模板
。所有其他受支持的文件可能位于存储库的根目录中.github文件
文件夹,或文档
文件夹。有关详细信息,请参阅“创建新文件."