跳至主要内容

向您的项目添加行为准则

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

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

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

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

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

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

使用模板添加行为准则

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

  1. 在 GitHub.com 上,导航到存储库的主页。

  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.com 上,导航到存储库的主页。

  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. 点击提交更改提出更改