跳至内容

Ansible 项目入驻

欢迎来到 Ansible 项目生态系统!本文件将引导您完成成为 Ansible 生态系统一部分的步骤。

为什么成为 Ansible 生态系统的一部分

成为 Ansible 生态系统的一部分意味着您正在接触一个庞大而繁荣的社区,这个社区充满了在 Ansible 上工作和志愿服务的热心人士。

成为 Ansible 生态系统一部分的主要优势包括

  • 您的项目文档在 docs.ansible.com/ecosystem 上的展示,以及成为官方 Ansible ReadTheDocs 空间的一部分。
  • 在(未来的)Ansible.com 上展示您的项目。
  • 专门的通信渠道(聊天和论坛)与您的社区沟通,并吸引其他社区成员参与您的项目。

入门

成为 Ansible 生态系统一部分的第一步是与 Ansible 社区团队 联系,讨论您的选择以及您的项目如何融入 Ansible 社区。这里后面的部分假设讨论已经完成,并且社区团队批准您的项目加入 Ansible 项目社区。

设置您的 GitHub 代码库

Ansible 生态系统项目存在于以下两个 GitHub 组织中

注意:此工具包不适用于 ansible-collections 组织中的 Ansible 集合。有关详细信息,请参阅 集合贡献者指南

我们建议大多数 Ansible 项目使用 ansible-community GitHub 组织。

迁移现有代码库

如果您的项目已经在 GitHub 的其他地方存在,则可以使用代码库迁移。请联系 Ansible 社区团队 寻求帮助。迁移的项目必须遵循本指南中描述的相同格式。

创建新项目

对于新项目,请使用 project-template 使用默认文件创建项目。

提交您的项目以供纳入

常见文件

注意:如果您使用 Ansible GitHub 项目模板,这些文件将包含在创建的代码库中。

所有 Ansible 生态系统项目都必须包含以下文件,这些文件列在 project_template 代码库的 README 中。

可选的其他步骤

虽然不是必需的,但您应该考虑在您的项目代码库中添加以下内容

  • 提供问题和 PR 模板以改善贡献者体验。

创建您的社区空间

每个 Ansible 生态系统项目都应该使用论坛和相关标签来与社区沟通和协作。有关更多信息,请参阅

联系 社区团队 以请求论坛中您的项目的新的标签(s)。

工作组

并非每个项目都需要工作组。我们建议项目尽可能使用 Ansible 论坛和 GitHub 问题,以方便所有时区的人访问。

工作组是您的贡献者组,以及协调工作的方式。这包括论坛的标签或组,以及可选的矩阵房间。

同步项目会议是一种选择,您可以使用 论坛事件日历 来宣布您的会议。请注意,任何实时会议往往会排除不在会议时区或附近时区的贡献者。

请参阅 工作组社区准则,了解有关设置和运行工作组的完整详细信息,包括在 Matrix 和论坛上进行异步讨论的同步会议。

提高对您项目的认识

使用以下通信选项让人们了解您的 Ansible 项目

培养和发展您的社区

  • 使用列出的通信选项让人们了解您的社区和项目成就。这包括 Matrix、Bullhorn 和论坛更新,用于

    • 新版本或更改
    • 请求帮助
    • 对社区贡献者的赞赏
    • 您项目的所有其他想法/成就/求助。
  • 在社区中工作……在社区中决定 - 您的项目团队越是在公开场合进行互动,您的社区就越强大。这包括讨论问题、功能,以及通常情况下,默认情况下作为一个团队在您的矩阵和论坛区域工作。如果可能,您可以赋予社区帮助制定项目路线图的权力,例如。

  • 求助!如果不去求助,有些人可能不知道您在某些领域需要帮助。而且具体的请求/问题比笼统的求助电话效果更好。

创建您的文档

我们有一个 文档指南 来帮助您设计和发布您的文档到 ReadTheDocs,作为 Ansible 生态系统的一部分。

项目治理

这些是关于如何治理您的项目,以创建一个包容性的社区的建议。

  • 授予受信任的贡献者合并权限。
  • 在您的 github 代码库中启用 CI 以尽可能自动化测试/验证。
  • 阻止 PR 所有者合并他们自己的 PR。每个 PR 都应该在合并之前获得一个或多个批准。
  • 要有项目路线图!