You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

Ansible Collections Contributor Guide

• The Ansible Collections Development Cycle
  • Macro development: roadmaps, releases, and projects
  • Micro development: the lifecycle of a PR
  • Making your PR merge-worthy
• Requesting changes to a collection
  • Reporting a bug
  • Requesting a feature
• Creating your first collection pull request
  • Prepare your environment
  • Change the code
  • Fix the bug
  • Test your changes
  • Submit a pull request
• Testing Collection Contributions
  • How to test a collection PR
  • Add unit tests to a collection
  • Adding integration tests to a collection
• Review checklist for collection PRs
  • Reviewing bug reports
  • Reviewing suggested changes
  • Review tests in the PR
  • Review for merge commits and breaking changes
• Guidelines for collection maintainers
  • Maintainer responsibilities
  • Expanding the collection community
  • Maintaining good collection documentation
  • Backporting and Ansible inclusion
  • Stepping down as a collection maintainer
  • Releasing collections
• Contributing to Ansible-maintained Collections
  • Ansible-maintained collections
  • Deciding where your contribution belongs
  • Requirements to merge your PR
• Ansible Community Steering Committee
  • Steering Committee mission and responsibilities
  • Steering Committee membership guidelines
  • Steering Committee past members
• Contributing to the Ansible Documentation
  • Editing docs directly on GitHub
  • Reviewing open PRs and issues
  • Opening a new issue and/or PR
  • Verifying your documentation PR
  • Joining the documentation working group
• Other Tools and Programs
• Popular editors
  • Atom
  • Emacs
  • PyCharm
  • Sublime
  • Visual studio code
  • vim
  • JetBrains
• Development tools
  • Finding related issues and PRs
• Tools for validating playbooks
• Other tools

If you have a specific Ansible interest or expertise (for example, VMware, Linode, and so on, consider joining a working group.

Working with the Ansible collection repositories

• How can I find editors, linters, and other tools that will support my Ansible development efforts?

• Where can I find guidance on coding in Ansible?

• How do I create a collection?

• How do I rebase my PR?

• How do I learn about Ansible’s testing (CI) process?

• How do I deprecate a module?

• See Collection developer tutorials for a quick introduction on how to develop and test your collection contributions.