跳至主要内容

在你的项目中添加行为准则

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

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

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

  • 研究为开源项目设计的不同行为准则。选择一个反映你社区标准的准则。
  • 仔细考虑你是否愿意并且能够执行它。

你可以通过使用模板或手动创建自定义行为准则来向你的项目添加行为准则。无论哪种方式,你的行为准则都将可用,但只有当你使用模板时,你的仓库的社区概况中才会将“行为准则”标记为已完成。如果你使用其他人或组织编写的行为准则,请务必遵循源代码中的任何归属指南。有关社区概况的更多信息,请参阅“关于公共仓库的社区概况”。

你可以为你的组织或个人账户创建默认的行为准则。有关更多信息,请参阅“创建默认社区健康文件”。

使用模板添加行为准则

GitHub 提供了常见行为准则的模板,以帮助你快速向你的项目添加行为准则。

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

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

    或者,你可以单击左侧的文件树视图中的。

    Screenshot of the main page of a repository. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.

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

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

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

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

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

  7. 单击**查看并提交**。

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

  9. 单击**提交更改...**

  10. 在“提交消息”字段中,键入简短且有意义的提交消息,描述你对文件所做的更改。你可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  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. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.

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

    • 要使你的行为准则在仓库的根目录中可见,请在文件名字段中键入CODE_OF_CONDUCT
    • 要使你的行为准则在仓库的docs目录中可见,请键入docs/CODE_OF_CONDUCT
    • 要使你的行为准则在仓库的.github目录中可见,请键入.github/CODE_OF_CONDUCT
  4. 在新文件中,添加你的自定义行为准则。

  5. 单击**提交更改...**

  6. 在“提交消息”字段中,键入简短且有意义的提交消息,描述你对文件所做的更改。你可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  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. 单击**提交更改**或**提出更改**。