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

创建默认社区健康文件

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

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

关于默认社区健康文件

You can add default community health files to the root of a public repository called .github that is owned by an organization or user account.

对于在以下任何位置不含该类型自有文件的帐户所拥有的任何公共仓库,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 仓库中。

支持的文件类型

You can create defaults in your organization or user account for the following community health files:

社区健康文件描述
CODE_OF_CONDUCT.mdCODE_OF_CONDUCT 文件定义如何参与社区的标准。 更多信息请参阅“为项目添加行为准则”。
CONTRIBUTING.mdCONTRIBUTING 文件说明人们应如何参与您的项目。 For more information, see "Setting guidelines for repository contributors."
FUNDING.ymlFUNDING 文件在仓库中显示赞助者按钮,以提高开源项目资助选项的可见性。 更多信息请参阅“在仓库中显示赞助按钮”。
Issue and pull request templates and config.yml议题和拉取请求模板可自定义和标准化您希望贡献者在您的仓库中打开议题和拉取请求时加入的信息。 For more information, see "About issue and pull request templates."
SECURITY.mdSECURITY 文件说明如何负责任地报告项目中的安全漏洞。 更多信息请参阅“添加安全政策到仓库”。
SUPPORT.mdSUPPORT 文件告知获取项目相关帮助的方式。 更多信息请参阅“为项目添加支持资源”。

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

创建用于默认文件的仓库

  1. 在任何页面的右上角,使用 下拉菜单选择 New repository(新建仓库)
    带有创建新仓库选项的下拉菜单
  2. Use the Owner drop-down menu, and select the organization or user account you want to create default files for.
    所有者下拉菜单
  3. 键入 .github 作为仓库的名称,可选择键入说明。
    创建仓库字段
  4. Make sure the repository status is set to Public (a repository for default files cannot be private).
    用于选择机密或公开状态的单选按钮
  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)
    使用自述文件初始化此仓库复选框
  6. Click Create repository.
    Button to create repository
  7. 在仓库中,创建一个受支持的社区健康文件。 Issue templates and their configuration file must be in a folder called .github/ISSUE_TEMPLATE. 所有其他支持的文件必须在仓库的根目录中。 更多信息请参阅“创建新文件”。

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。