Skip to main content

为项目添加行为准则

采用行为准则制定社区标准,宣示欢迎大家参与的包容性项目,并且阐述对滥用的处理程序。

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

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

  • 研究为开源项目设计的不同行为准则。 选择一个反映您的社区标准的行为准则。
  • 认真考虑您是否愿意和能够实施该行为准则。

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

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

使用模板添加行为准则

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

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

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

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

    存储库主页的屏幕截图。 在文件列表上方,标有“添加文件”的按钮以深橙色框出。 在存储库的文件树状视图中,带加号图标的按钮也以深橙色框出。

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

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

    GitHub 存储库的屏幕截图,其中显示正在创建新 Markdown 文件。 右侧标记为“选择行为准则模板”的按钮以深橙色框出。

  5. 在页面左边选择行为准则进行预览并添加到项目。

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

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

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

  9. 单击“提交更改...”

  10. 在“提交消息”字段中,输入简短、有意义的提交消息,以描述对文件的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建有多个作者的提交”。

  11. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建拉取请求”。

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。

  12. 单击“提交更改”或“建议更改” 。

手动添加行为准则

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

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

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

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

    存储库主页的屏幕截图。 在文件列表上方,标有“添加文件”的按钮以深橙色框出。 在存储库的文件树状视图中,带加号图标的按钮也以深橙色框出。

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

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

  5. 单击“提交更改...”

  6. 在“提交消息”字段中,输入简短、有意义的提交消息,以描述对文件的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建有多个作者的提交”。

  7. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建拉取请求”。

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。

  8. 单击“提交更改”或“建议更改” 。