mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
7.6 KiB
ReStructuredText
115 lines
7.6 KiB
ReStructuredText
****************
|
|
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's 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.
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
|
|
|
|
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 :ref:`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:
|
|
|
|
- `Ansible Core <https://docs.ansible.com/ansible-core/devel/index.html>`_
|
|
- `Collections <https://docs.ansible.com/ansible/latest/user_guide/collections_using.html>`_
|
|
- `AWX <https://github.com/ansible/awx>`_
|
|
- `Galaxy <https://galaxy.ansible.com/>`_
|
|
- `ansible-lint <https://ansible-lint.readthedocs.io/en/latest/>`_
|
|
- `Molecule <https://molecule.readthedocs.io/en/latest/>`_
|
|
|
|
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:
|
|
|
|
- `Python programming language <https://docs.python.org/3/tutorial/>`_
|
|
- `Git <https://git-scm.com/docs/gittutorial>`_
|
|
- `GitHub collaborative development model through forks and pull requests <https://docs.github.com/en/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models>`_
|
|
|
|
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.
|
|
|
|
* :ref:`Ansible Core development <developer_guide>`.
|
|
* :ref:`Ansible collection development <developing_collections>` 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 :ref:`how_can_i_help`.
|
|
|
|
If you are interested in contributing to collections, take a look at :ref:`collection contributions<collections_contributions>` and the `collection repository <https://github.com/ansible-collections/>`_'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:
|
|
|
|
- `Ansible collections repositories <https://github.com/search?q=user%3Aansible-collections+label%3Aeasyfix%2C%22good+first+issue%22+state%3Aopen&type=Issues>`_
|
|
- `All other Ansible projects <https://github.com/search?q=user%3Aansible+user%3Aansible-community+label%3Aeasyfix%2C%22good+first+issue%22+state%3Aopen&type=Issues>`_
|
|
|
|
Issues labeled with the ``docs`` label in `Ansible collections <https://github.com/search?q=user%3Aansible-collections+label%3Adocs+state%3Aopen+type%3Aissue&type=Issues>`_ and `other <https://github.com/search?q=user%3Aansible+user%3Aansible-community+label%3Adocs+state%3Aopen+type%3Aissue&type=Issues>`_ 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 :ref:`communication` 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 :ref:`improving documentation<community_documentation_contributions>`, answering questions from other contributors and users on :ref:`Matrix/Libera.Chat IRC<communication>`, giving advice on issues and pull requests, and discussing `Community Topics <https://github.com/ansible-community/community-topics/issues>`_.
|
|
|
|
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 :ref:`maintainers` for details.
|
|
|
|
For some collections that use the `collection bot <https://github.com/ansible-community/collection_bot>`_, such as `community.general <https://github.com/ansible-collections/community.general>`_ and `community.network <https://github.com/ansible-collections/community.network>`_, you can have different levels of access and permissions.
|
|
|
|
* :ref:`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 as ``commit``. 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 :ref:`maintainers`.
|
|
|
|
For information about permission levels, see the `GitHub official documentation <https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization>`_.
|
|
|
|
Become a steering committee member
|
|
==================================
|
|
|
|
.. note::
|
|
|
|
You do NOT have to be a programmer to become a steering committee member.
|
|
|
|
The :ref:`Steering Committee <community_steering_committee>` member status reflects the highest level of trust which allows contributors to lead the project by making very important `decisions <https://github.com/ansible-community/community-topics/issues>`_ for the Ansible project. The Committee members are the 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 <https://github.com/ansible-community/community-topics/issues>`_.
|
|
* Propose your topics.
|
|
* If time permits, join the `Community meetings <https://github.com/ansible/community/blob/main/meetings/README.md#schedule>`_. Note this is **NOT** a requirement.
|