Ansible Community Guide¶
Making Open Source More Inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. We ask that you open an issue or pull request if you come upon a term that we have missed. For more details, see our CTO Chris Wright’s message.
Welcome to the Ansible Community Guide!
The purpose of this guide is to teach you everything you need to know about being a contributing member of the Ansible community. All types of contributions are welcome and necessary to Ansible’s continued success.
This page outlines the most common situations and questions that bring readers to this section. If you prefer a traditional table of contents, you can find one at the bottom of the page.
I am new to the community. Where can I find the Ansible Community Code of Conduct?
I would like to know what I am agreeing to when I contribute to Ansible. Does Ansible have a Contributors License Agreement?
I would like to contribute but I am not sure how. Are there easy ways to contribute?
I want to talk to other Ansible users. How do I find an Ansible Meetup near me?
I have a question. Which Ansible email lists and IRC channels will help me find answers?
I want to learn more about Ansible. What can I do?
I would like updates about new Ansible versions. How are new releases announced?
I want to use the current release. How do I know which releases are current?
I think Ansible is broken. How do I report a bug?
I need functionality that Ansible does not offer. How do I request a feature?
I am waiting for a particular feature. How do I see what is planned for future Ansible Releases?
I have a specific Ansible interest or expertise (for example, VMware, Linode, and so on). How do I get involved in a working group?
I would like to participate in conversations about features and fixes. How do I review GitHub issues and pull requests?
I found a typo or another problem on docs.ansible.com. How can I improve the documentation?
Is there a mailing list I can sign up for to stay informed about Ansible?
Working with the Ansible repo¶
I want to make my first code changes to a collection or to
ansible-base. 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 want to learn more about Ansible roadmaps, releases, and projects. How do I find information on the development cycle?
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
develbranch. 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?
Traditional Table of Contents¶
If you prefer to read the entire Community Guide, here is a list of the pages in order:
- Community Code of Conduct
- How can I help?
- Reporting bugs and requesting features
- Contributing to the Ansible Documentation
- The Ansible Development Cycle
- Contributing to Ansible-maintained Collections
- Contributors License Agreement
- Triage Process
- Other Tools and Programs
- Popular editors
- Development tools
- Tools for validating playbooks
- Other tools
- Ansible style guide