我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

为组织创建默认社区健康文件

您可以为组织创建默认社区健康文件,例如 CONTRIBUTING 和 CODE_OF_CONDUCT。 默认文件将用于组织中不包含该类型自有文件的任何公共仓库。

本文内容

关于默认社区健康文件

您可以将组织的默认社区健康文件添加到组织拥有的 .github 公共仓库的根目录中。

对于组织中在以下任何位置都不含该类型自有文件的任何公共仓库,GitHub 将使用并显示默认文件:

  • 仓库的根目录
  • .github 文件夹
  • docs 文件夹

例如,在不含自有 CONTRIBUTING 文件的公共仓库中创建议题或拉取请求的人将会看到指向默认 CONTRIBUTING 文件的链接。 If a repository has any files in its own .github/ISSUE_TEMPLATE folder, including issue templates or a config.yml file, none of the contents of the default .github/ISSUE_TEMPLATE folder will be used.

默认文件不包含在各个仓库的克隆、包或下载中,因为它们只存储在 .github 仓库中。

支持的文件类型

您可以创建组织范围的以下默认社区健康文件:

Community health file 描述
CODE_OF_CONDUCT.md A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "Adding a code of conduct to your project."
CONTRIBUTING.md A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "Setting guidelines for repository contributors."
FUNDING.yml A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. 更多信息请参阅“在仓库中显示赞助按钮”。
Issue and pull request templates and config.yml Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "About issue and pull request templates."
SECURITY.md A SECURITY file gives instructions for how to responsibly report a security vulnerability in your project. For more information, see "Adding a security policy to your repository."
SUPPORT.md A SUPPORT file lets people know about ways to get help with your project. 更多信息请参阅“为项目添加支持资源”。

无法为组织创建默认许可文件。 必须将许可文件添加到各个仓库中,以便在克隆、打包或下载项目时包含该文件。

创建用于默认文件的仓库

  1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

    Drop-down with option to create a new repository

  2. 使用 Owner(所有者)下拉菜单,选择要为其创建默认文件的组织。

    所有者下拉菜单

  3. 键入 .github 作为仓库的名称,可选择键入说明。

    创建仓库字段

  4. 选择让仓库公开。

    用于选择机密或公开状态的单选按钮

  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)

    使用自述文件初始化此仓库复选框

  6. 单击 Create repository(创建仓库)

  7. 在仓库中,创建一个受支持的社区健康文件。 Issue templates and their configuration file must be in a folder called .github/ISSUE_TEMPLATE. 所有其他支持的文件必须在仓库的根目录中。 更多信息请参阅“创建新文件”。

问问别人

找不到要找的内容?

联系我们