将您的模块贡献给现有的 Ansible 集合

如果您想将模块贡献给现有的集合，您必须满足社区的客观和主观要求。请阅读下面的详细信息，并查看我们的模块开发技巧。

被某些集合接受的模块会包含在 PyPI 上的每个 Ansible 版本中。但是，贡献给其中一个集合并不是分发模块的唯一方法 - 您可以创建自己的集合，将模块嵌入 Galaxy 上的角色中，或者只是共享您的模块代码副本以供本地使用。

贡献模块：客观要求

要将模块贡献给大多数 Ansible 集合，您必须

使用 Python 或 Powershell 为 Windows 编写模块
使用 AnsibleModule 通用代码
支持 Python 2.6 和 Python 3.5 - 如果您的模块无法支持 Python 2.6，请在 DOCUMENTATION 的 requirements 部分中解释所需的最低 Python 版本和理由
使用正确的 Python 3 语法
遵循 PEP 8 Python 样式约定 - 有关更多信息，请参阅 pep8
在 GPL 许可证（GPLv3 或更高版本）下许可您的模块
理解 DCO 协议，该协议适用于对 Ansible Core 和 Ansible 文档存储库的贡献。
符合 Ansible 的格式化和文档标准
为您的模块包含全面的测试
最小化模块依赖项
如果可能，支持 check_mode
确保您的代码可读
如果模块名为 <something>_facts，则应是因为其主要目的是返回 ansible_facts。不要将不执行此操作的模块命名为 _facts。仅将 ansible_facts 用于特定于主机的信息，例如网络接口及其配置、操作系统以及安装了哪些程序。
查询/返回常规信息（而不是 ansible_facts）的模块应命名为 _info。常规信息是非主机特定信息，例如在线/云服务的信息（您可以从同一主机访问同一在线服务的不同帐户），或可以从计算机访问的 VM 和容器的信息。

其他要求可能适用于某些集合。查看各个集合存储库以获取更多信息。

请在提交 PR/提案之前确保您的模块符合这些要求。如果您有疑问，请访问 Ansible 通信指南，以获取有关如何联系社区的信息。

如果您的模块满足这些客观要求，则集合维护者将审查您的代码，以查看他们是否认为代码清晰、简洁、安全且可维护。他们将考虑您的模块是否提供良好的用户体验、有用的错误消息、合理的默认值等。此过程是主观的，没有确切的接受标准。为了获得最大的模块接受机会，请遵循我们的模块开发技巧。