ansible-core Contributors Guide

• Reporting bugs and requesting features
  • Reporting a bug
  • Requesting a feature
• Contributing to the Ansible Documentation
  • Editing docs directly on GitHub
  • Reviewing or solving open issues
  • Reviewing open PRs
  • Opening a new issue and/or PR
  • Verifying your documentation PR
  • Joining the documentation working group
• The Ansible Development Cycle
  • Macro development: ansible-core roadmaps, releases, and projects
  • Micro development: the lifecycle of a PR
  • Making your PR merge-worthy
  • Backporting merged PRs in ansible-core
• Other Tools and Programs
  • Popular editors
  • Development tools
  • 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 repo

• I want to make my first code changes to a collection or to ansible-core. How do I set up my Python development environment?

• I would like to get more efficient as a developer. How can I find editors, linters, and other tools that will support my Ansible development efforts?

• I want my code to meet Ansible’s guidelines. Where can I find guidance on coding in Ansible?

• I would like to connect Ansible to a new API or other resource. How do I create a collection?

• My pull request is marked needs_rebase. How do I rebase my PR?

• I am using an older version of Ansible and want a bug fixed in my version that has already been fixed on the devel branch. How do I backport a bugfix PR?

• I have an open pull request with a failing test. How do I learn about Ansible’s testing (CI) process?

• I am ready to step up as a collection maintainer. What are the guidelines for maintainers?

• A module in a collection I maintain is obsolete. How do I deprecate a module?