Skip to content

Commit 104b1dd

Browse files
community/maintainers_guidelines.rst: improve the document. Assisted-by: Gemini (#2808) (#2824)
* community/maintainers_guidelines.rst: improve the document. Assisted-by: Gemini * Misc fixes (cherry picked from commit 06427c3) Co-authored-by: Andrew Klychkov <[email protected]>
1 parent a5d814e commit 104b1dd

File tree

1 file changed

+38
-41
lines changed

1 file changed

+38
-41
lines changed

docs/docsite/rst/community/maintainers_guidelines.rst

Lines changed: 38 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
Maintainer responsibilities
44
===========================
55

6-
This document is intended for:
6+
This document provides guidance for:
77

8-
* Contributors to collections who are interested in joining their maintainer teams.
9-
* Collection maintainers who want to learn more about the subject.
8+
* Contributors to collections who want to join maintainer teams.
9+
* Collection maintainers seeking to understand their roles better.
1010

11-
This document explains what a collection maintainer is, outlines their responsibilities, and describes the process for becoming one.
11+
This document defines the role of an Ansible collection maintainer, outlines their responsibilities, and describes the process for becoming one.
1212

1313
.. contents::
1414
:depth: 1
@@ -17,85 +17,82 @@ This document explains what a collection maintainer is, outlines their responsib
1717
Collection maintainer definition
1818
--------------------------------
1919

20-
An Ansible collection maintainer (or maintainer for short) is a contributor who:
20+
An Ansible collection maintainer, or simply maintainer, is a contributor who:
2121

22-
* Makes significant and regular contributions to the project.
23-
* Has shown themselves as a specialist in the area the collection automates.
24-
* Trusted by the community: to be able to perform their duties, maintainers have the ``write`` or higher access level in the collection.
22+
* Makes significant and regular contributions to a project.
23+
* Demonstrates expertise in the area the collection automates.
24+
* Earns the community's trust. To fulfill their duties, maintainers have ``write`` or higher access to the collection.
2525

2626
Maintainer responsibilities
2727
---------------------------
2828

29-
Collection maintainers:
29+
Collection maintainers perform the following tasks:
3030

3131
* Act in accordance with the :ref:`code_of_conduct`.
32-
* Subscribe to the repository they maintain (click :guilabel:`Watch > All activity` in GitHub).
33-
* Keep README, development guidelines, and other general :ref:`maintainer_documentation` relevant.
34-
* Review using the :ref:`review_checklist` and commit changes made by other contributors.
32+
* Subscribe to the repository they maintain. In GitHub, click :guilabel:`Watch > All activity`.
33+
* Keep the ``README``, development guidelines, and other general :ref:`maintainer_documentation` current.
34+
* Review and commit changes from other contributors using the :ref:`review_checklist`.
3535
* :ref:`Backport <Backporting>` changes to stable branches.
3636
* :ref:`Plan and perform releases <Releasing>`.
37-
* Ensure that the collection adhere to the :ref:`collections_requirements`.
38-
* Track changes announced through the `news-for-maintainers <https://forum.ansible.com/tag/news-for-maintainers>`_ forum tag (click the ``Bell`` button) and update the collection accordingly.
39-
* :ref:`Build a healthy community <expanding_community>` to increase the number of active contributors and maintainers around collections.
37+
* Ensure the collection adheres to the :ref:`collections_requirements`.
38+
* Track changes announced through the `news-for-maintainers <https://forum.ansible.com/tag/news-for-maintainers>`_ forum tag. Click the ``Bell`` button to subscribe. Update the collection accordingly.
39+
* :ref:`Build a healthy community <expanding_community>` to increase the number of active contributors and maintainers for collections.
4040

41-
Multiple maintainers can divide responsibilities among each other.
41+
Multiple maintainers can divide these responsibilities among themselves.
4242

4343
Becoming a maintainer
4444
---------------------
4545

46-
If you are interested in becoming a maintainer and satisfy the :ref:`requirements<maintainer_requirements>`, please nominate yourself. You can also nominate another person:
46+
If you are interested in becoming a maintainer and meet the :ref:`requirements<maintainer_requirements>`, nominate yourself. You can also nominate another person by following these steps:
4747

4848
1. Create a GitHub issue in the relevant repository.
49-
2. If there is no response, message the `Red Hat Ansible Community Engineering Team <https://forum.ansible.com/g/CommunityEngTeam>`_ on the `Ansible forum <https://forum.ansible.com/>`_.
49+
2. If you receive no response, message the `Red Hat Ansible Community Engineering Team <https://forum.ansible.com/g/CommunityEngTeam>`_ on the `Ansible forum <https://forum.ansible.com/>`_.
5050

5151
Communicating as a maintainer
5252
-----------------------------
5353

54-
Maintainers communicate with the community through channels listed in the :ref:`Ansible communication guide<communication>`.
54+
Maintainers communicate with the community through the channels listed in the :ref:`Ansible communication guide<communication>`.
5555

5656
.. _wg_and_real_time_chat:
5757

5858
Establishing working group communication
5959
----------------------------------------
6060

61-
Working groups depend on efficient communication.
62-
As a maintainer, you can use the following techniques to establish communication for your working groups:
61+
Working groups rely on efficient communication. As a maintainer, you can establish communication for your working groups using these techniques:
6362

64-
* Find an existing `forum group <https://forum.ansible.com/g>`_ and tags that suit your project and join the conversation.
63+
* Find and join an existing `forum group <https://forum.ansible.com/g>`_ and use tags that suit your project.
6564

66-
* If nothing suits, `request them <https://forum.ansible.com/t/working-groups-things-you-can-ask-for/175>`_.
65+
* If no suitable options exist, `request them <https://forum.ansible.com/t/working-groups-things-you-can-ask-for/175>`_.
6766

68-
* Provide working group details and links to chat rooms in the contributor section of your project ``README.md``.
69-
* Encourage contributors to join the forum group and appropriate tags.
67+
* Provide working group details and chat room links in the contributor section of your project's ``README.md``.
68+
* Encourage contributors to join the forum group and use appropriate tags.
7069

7170
Participating in community topics
7271
---------------------------------
7372

74-
The Community and the :ref:`Steering Committee <steering_responsibilities>` asynchronously discuss and vote on the :ref:`community topics<creating_community_topic>`.
75-
The topics impact the whole project or its parts including collections and packaging.
73+
The Community and the :ref:`Steering Committee <steering_responsibilities>` discuss and vote on :ref:`community topics<creating_community_topic>` asynchronously. These topics impact the entire project or its components, including collections and packaging.
7674

77-
Share your opinion and vote on the topics to help the community make the best decisions.
75+
Share your opinion and vote on the topics to help the community make informed decisions.
7876

7977
.. _expanding_community:
8078

8179
Expanding the collection community
8280
==================================
8381

84-
Here are some ways you can expand the community around your collection:
82+
You can expand the community around your collection in the following ways:
8583

86-
* Have it explicitly in your ``README`` that the collection welcomes new maintainers and contributors.
84+
* Explicitly state in your ``README`` that the collection welcomes new maintainers and contributors.
8785
* Give :ref:`newcomers a positive first experience <collection_new_contributors>`.
88-
* Invite contributors to join forum groups/subscribe to tags related to your project.
89-
* Have :ref:`good documentation <maintainer_documentation>` with guidelines for new contributors.
90-
* Make people feel welcome personally and individually. Greet and thanks them.
91-
* Use labels to show easy fixes and leave non-critical easy fixes to newcomers.
86+
* Invite contributors to join forum groups and subscribe to tags related to your project.
87+
* Maintain :ref:`good documentation <maintainer_documentation>` with guidelines for new contributors.
88+
* Make people feel welcome personally and individually. Greet and thank them.
89+
* Use labels to identify easy fixes and leave non-critical easy fixes to newcomers.
9290
* Offer help explicitly.
93-
* Include quick ways contributors can help and contributor documentation references in your ``README``.
94-
* Be responsive in issues, pull requests (or PRs for short) and other communication channels.
91+
* Include quick ways contributors can help and provide contributor documentation references in your ``README``.
92+
* Be responsive in issues, pull requests (PRs), and other communication channels.
9593
* Conduct PR days regularly.
96-
* Maintain a zero-tolerance policy towards behavior violating the :ref:`code_of_conduct`.
97-
98-
* Put information about how people can register code of conduct violations in your ``README`` and ``CONTRIBUTING`` files.
94+
* Maintain a zero-tolerance policy toward behavior that violates the :ref:`code_of_conduct`.
95+
* Include information about how people can report code of conduct violations in your ``README`` and ``CONTRIBUTING`` files.
9996

10097
* Look for new maintainers among active contributors.
10198

@@ -104,12 +101,12 @@ Here are some ways you can expand the community around your collection:
104101
Maintaining good collection documentation
105102
=========================================
106103

107-
Look after the collection documentation to ensure:
104+
Ensure the collection documentation meets these criteria:
108105

109106
* It is up-to-date.
110107
* It matches the :ref:`style_guide`.
111108
* Collection module and plugin documentation adheres to the :ref:`Ansible documentation format <module_documenting>`.
112109
* Collection user guides follow the :ref:`Collection documentation format <collections_doc_dir>`.
113110
* Repository files include at least a ``README`` and ``CONTRIBUTING`` file.
114111
* The ``README`` file contains all sections from `collection_template/README.md <https://github.com/ansible-collections/collection_template/blob/main/README.md>`_.
115-
* The ``CONTRIBUTING`` file includes all the details or links to the details on how a new or continuing contributor can contribute to your collection.
112+
* The ``CONTRIBUTING`` file includes all details or links to details on how new or continuing contributors can contribute to your collection.

0 commit comments

Comments
 (0)