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