Skip to main content

为项目添加行为准则

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

在本文中

行为准则定义关于如何参与社区的标准。 它宣示一个尊重所有贡献的包容性环境。 还说明解决项目社区成员间问题的程序。 若要详细了解为何行为准则要定义有关如何参与社区的标准和期望,请参阅开源指南

在对项目采用行为准则之前:

  • 研究针对open source项目设计的不同行为准则。 选择一个符合您社区标准的。
  • 认真考虑您是否愿意和能够实施该行为准则。

您可以使用模板向项目添加行为准则,或手动创建自定义行为准则。 你的行为守则可以通过以下任何方式获得,但如果你使用模板,“行为准则”只在你仓库的社区配置文件中标记为完成。 如果您使用由他人或组织编写的行为准则,必须遵守来源方的任何归属指导原则。 有关社区概况的详细信息,请参阅 关于公共仓库的社区资料

你可以为组织或个人帐户创建默认的行为准则。 有关详细信息,请参阅“创建默认的社区运行状况文件”。

使用模板添加行为准则

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

  1. 在 GitHub 上,导航到存储库的主页面。1. 在文件列表上方,选择“Add file” 下拉菜单,然后单击“ Create new file”********。

    也可在左侧的文件树状视图中单击

    仓库主页的屏幕截图,其中突出显示了“添加文件”和“加号”两个图标(如上所述以橙色框出)。

  2. 在文件名字段中输入“CODE_OF_CONDUCT.md”。

  3. 选择“选择行为准则模板”。

           ![显示新 markdown 文件的存储库屏幕截图。 右侧标有“选择行为准则模板”的按钮以橙色边框显示。](/assets/images/help/repository/code-of-conduct-tool.png)
    
  4. 在页面左边选择行为准则进行预览并添加到项目。

  5. 在页面右边完成字段,在所选的行为准则中填写适当的信息。

  6. 单击“查看并提交”。

  7. 检查文本区域中的行为准则内容。 数据reusables.files.write_commit_message %}数据reusables.files.choose_commit_branch %}数据reusables.files.propose_new_file %}

手动添加行为准则

如果提供的模板中没有要使用的行为准则,您可以手动添加行为准则。

  1. 在 GitHub 上,导航到存储库的主页面。1. 在文件列表上方,选择“Add file” 下拉菜单,然后单击“ Create new file”********。

    也可在左侧的文件树状视图中单击

    仓库主页的屏幕截图,其中突出显示了“添加文件”和“加号”两个图标(如上所述以橙色框出)。

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

    • 要在存储库根目录中显示行为准则,请在文件名字段中键入“CODE_OF_CONDUCT”。
    • 要在存储库的 docs 目录中显示行为准则,请键入“docs/CODE_OF_CONDUCT”。
    • 要在存储库的 .github 目录中显示行为准则,请键入“.github/CODE_OF_CONDUCT”。
  3. 在新文件中添加您的自定义行为准则。 数据reusables.files.write_commit_message %}数据reusables.files.choose_commit_branch %}数据reusables.files.propose_new_file %}