关于默认社区健康文件
可以将默认社区运行状况文件添� 到存储库� �目录下或者 docs
或 .github
文件夹中名为 .github
的公共存储库中。
对于在以下任何位置不含该类型自有文件的帐户所拥有的任何仓库,GitHub Enterprise Server 将使用并显示默认文件:
- 仓库的� �目录
.github
文件夹docs
文件夹
例如,在不含自有 CONTRIBUTING 文件的仓库中创建议题或拉取请求的人将会看到指向默认 CONTRIBUTING 文件的链接。 如果存储库在其自己的 .github/ISSUE_TEMPLATE
文件夹中含有任何文件,包括议题模板或 config.yml 文件,则不会使用默认 .github/ISSUE_TEMPLATE
文件夹的内容。
默认文件不包含在各个存储库的克隆、包或下载中,� 为它们只存储在 .github
存储库中。
支持的文件类型
可以在组织或个人帐户中为以下社区运行状况文件创建默认内容:
社区运行状况文件 | 说明 --- | --- CONTRIBUTING.md | CONTRIBUTING 文件指示应如何参与� 的项目。 有关详细信息,请参阅“设置存储库贡献者指南”。 问题和拉取请求模板 和 config.yml | 问题和拉取请求模板可自定义和� �准化� 希望参与者在存储库中打开问题或拉取请求时包含的信息。 有关详细信息,请参阅“关于问题和拉取请求模板。” SECURITY.md | SECURITY 文件阐述了如何报告项目中的安全漏洞。 有关详细信息,请参阅“向存储库添� 安全策略。” SUPPORT.md | SUPPORT 文件介绍在项目中获取帮助的途径。 有关详细信息,请参阅“向项目添� 支持资源”。
您不能创建默认许可文件。 必须将许可文件添� 到各个仓库中,以便在克隆、打包或下载项目时包含该文件。
创建用于默认文件的仓库
- 在任何页面的右上角,使用 下拉菜单选择“新建存储库”。
- 使用“所有者”下拉菜单,选择要为其创建默认文件的组织或个人帐户。
- 输入“.github”作为存储库的名称和描述(可选)。
- 确保存储库状态设置为“公共”(默认文件的存储库不能是私有的)。 1. 选择“使用 README 初始化此存储库”。 1. 单击“创建存储库”。
- 在仓库中,创建一个受支持的社区健康文件。 议题模板 及其配置文件 必须位于名为
.github/ISSUE_TEMPLATE
的文件夹中。 所有其他支持的文件可能位于存储库� �目录、.github
文件夹或docs
文件夹中。 有关详细信息,请参阅“新建文件”。