Contributor path
This section describes the contributor’s journey from the beginning to becoming a leader who helps shape the future of Ansible. You can use this path as a roadmap for your long-term participation.
Any contribution to the project, even a small one, is very welcome and valuable. Any contribution counts, whether it is feedback on an issue, a pull request, a topic or documentation change, or a coding contribution. When you contribute regularly, your proficiency and judgment in the related area increase and, along with this, the importance of your presence in the project.
Determine your area of interest
First, determine areas that are interesting to you. Consider your current experience and what you’d like to gain. For example, if you use a specific collection, have a look there. See How can I help? for more ideas on how to help.
Find the corresponding project
These are multiple community projects in the Ansible ecosystem you could contribute to:
Learn
The required skillset depends on the area of interest and the project you’ll be working on. Remember that the best way to learn is by doing.
Specific knowledge for code developers
Code development requires the most technical knowledge. Let’s sort out what an Ansible developer should learn.
You should understand at least the basics of the following tools:
You can learn these tools more in-depth when working on your first contributions.
Each Ansible project has its own set of contributor guidelines. Familiarize yourself with these as you prepare your first contributions.
Ansible collection development and the collection-level contributor guidelines in the collection repository.
Making your first contribution
You can find some ideas on how you can contribute in How can I help?.
If you are interested in contributing to collections, take a look at collection contributions and the collection repository’s README
and CONTRIBUTING
files. To make your first experience as smooth as possible, read the repository documentation carefully, then ask the repository maintainers for guidance if you have any questions.
Take a look at GitHub issues labeled with the easyfix
and good_first_issue
labels for:
Issues labeled with the docs
label in Ansible collections and other Ansible projects can be also good to start with.
When you choose an issue to work on, add a comment directly on the GitHub issue to say you are looking at it and let others know to avoid conflicting work. You can also ask for help in a comment if you need it.
Continue to contribute
We don’t expect everybody to know everything. Start small, think big. When you contribute regularly, your proficiency and judgment in the related area will improve quickly and, along with this, the importance of your presence in the project.
See Communicating with the Ansible community for ways to communicate and engage with the Ansible community, including working group meetings, accessing the Bullhorn news bulletin, and upcoming contributor summits.
Teach others
Share your experience with other contributors through improving documentation, answering questions from other contributors and users on Matrix/Libera.Chat IRC, giving advice on issues and pull requests, and discussing topics on the Forum.
Become a collection maintainer
If you are a code contributor to a collection, you can get extended permissions in the repository and become a maintainer. A collection maintainer is a contributor trusted by the community who makes significant and regular contributions to the project and showed themselves as a specialist in the related area. See Guidelines for collection maintainers for details.
For some collections that use the collection bot, such as community.general and community.network, you can have different levels of access and permissions.
Module maintainers - The stage prior to becoming a collection maintainer. The file is usually a module or plugin. File maintainers have indirect commit rights.
supershipit permissions - Similar to being a file maintainer but the scope where a maintainer has the indirect commit is the whole repository.
triage
- Access to the repository that allows contributors to manage issues and pull requests.write
access to the repository also known ascommit
. In other words, become a committer. This access level allows contributors to merge pull requests to the development branch as well as perform all the other activities listed in the Guidelines for collection maintainers.
For information about permission levels, see the GitHub official documentation.
Become a steering committee member
Note
You do NOT have to be a programmer to become a steering committee member.
The Steering Committee member status reflects the highest level of trust and allows contributors to lead the project by making important decisions for the Ansible project. The Committee members are community leaders who shape the project’s future and the future of automation in the IT world in general.
To reach the status, as the current Committee members did before getting it, along with the things mentioned in this document, you should:
Subscribe to, comment on, and vote on the community topics<creating_community_topic>.
Propose your topics.
If time permits, join the Community meetings. Note this is NOT a requirement.