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