Ansible 生态系统项目开发资源

本文档列出了旨在帮助有兴趣在 Ansible 生态系统 中开发社区项目的贡献者的资源。

注意

非常欢迎对本文档中所列资源或文档本身提出任何改进建议!请在相应的 GitHub 仓库中提交 issue 或 pull request。

入职工具包

Ansible 入职工具包 (Onboarding toolkit) 提供了关于如何为新项目设置 GitHub 仓库以及项目应包含的文档类型的指南。

尽管该工具包最初是为 ansible-community GitHub 组织下的 Ansible 生态系统项目开发的,但欢迎所有人使用此入职工具包。

项目模板

Ansible 项目模板 (project-template) 是一个用于 Ansible 生态系统项目的 GitHub 仓库模板,其中包含:

  • 每个仓库中通常会出现的文件,例如 README、许可证、行为准则等。

  • 一个文档站点 (docsite) 模板,鼓励您在项目中使用该模板,以便在整个 Ansible 项目生态系统中提供一致的体验。

请查看由项目模板构建的 文档站点 以查看其实际效果。

欢迎您使用该模板,填写您的项目特定信息,使用 Sphinx 进行构建,然后将其发布。

即使您的项目不是新项目且已经拥有文档,我们仍建议您查看该模板,检查是否遗漏了针对项目用户、贡献者和维护者的相关文档。

社区策展项目列表

无论您的项目仓库是在 ansible-community GitHub 组织下还是在您自己的组织下,都欢迎将您的项目添加到 Awesome Ansible 列表 中。

在通过将其添加到列表来向社区展示您的优秀项目之前,请确保它符合 入职工具包 中说明的标准,以提供最佳的用户和贡献者体验。