跳至主要内容

向项目添加行为准则

采用行为准则来定义社区标准,彰显一个受欢迎且包容的项目,并概述处理滥用的程序。

行为准则定义了在社区中如何互动的标准。它表明了一个尊重所有贡献的包容性环境。它还概述了处理项目社区成员之间问题的程序。欲了解更多关于行为准则为何能够为社区中的互动设定标准和期望的信息,请参阅 开源指南

在为您的项目采用行为准则之前

  • 研究针对开源项目制定的各种行为准则。选择一个符合您社区标准的准则。
  • 仔细考虑您是否愿意并有能力执行该准则。

您可以通过使用模板或手动创建自定义行为准则来为项目添加行为准则。无论采用哪种方式,您的行为准则都会可用,但只有在使用模板时,“行为准则”才会在仓库的社区概况中被标记为完成。如果您使用了他人或组织编写的行为准则,请务必遵循来源的署名指南。有关社区概况的更多信息,请参阅 公共仓库的社区概况概述

您可以为您的组织或个人账户创建默认的行为准则。欲了解更多信息,请参阅 创建默认的社区健康文件

使用模板添加行为准则

GitHub 提供了常见行为准则的模板,帮助您快速将行为准则添加到项目中。

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在文件列表上方,选择 添加文件下拉菜单,然后点击 创建新文件

    或者,您可以点击在左侧的文件树视图中。

    Screenshot of the main page of a repository highlighting both the "Add file" and the "plus sign" icon, described above, with an orange outline.

  3. 在文件名字段中,输入 CODE_OF_CONDUCT.md

  4. 选择 选择行为准则模板

    Screenshot of a repository showing a new markdown file. A button at right, labeled "Choose a code of conduct template," is outlined in orange.

  5. 在页面左侧,选择一个行为准则进行预览并添加到您的项目中。

  6. 在页面右侧,填写字段以使用适当的信息填充所选的行为准则。

  7. 点击 审查并提交

  8. 审查文本区域中行为准则的内容。

  9. 点击 提交更改...

  10. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  11. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  12. 点击 提交更改提议更改

手动添加行为准则

如果您想使用的行为准则在提供的模板中不可用,您可以手动添加行为准则。

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在文件列表上方,选择 添加文件下拉菜单,然后点击 创建新文件

    或者,您可以点击在左侧的文件树视图中。

    Screenshot of the main page of a repository highlighting both the "Add file" and the "plus sign" icon, described above, with an orange outline.

  3. 在文件名字段中,输入文件的名称和扩展名。

    • 若要在仓库根目录中显示您的行为准则,请在文件名字段中输入 CODE_OF_CONDUCT
    • 若要在仓库的 docs 目录中显示您的行为准则,请输入 docs/CODE_OF_CONDUCT
    • 若要在仓库的 .github 目录中显示您的行为准则,请输入 .github/CODE_OF_CONDUCT
  4. 在新文件中,添加您的自定义行为准则。

  5. 点击 提交更改...

  6. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  7. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  8. 点击 提交更改提议更改

© . This site is unofficial and not affiliated with GitHub, Inc.