Skip to content

Commit c4b0f96

Browse files
committed
doc: add *add-new-maintainer* guide
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 5f37d94 commit c4b0f96

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

NEWS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Modules 5.6.0 (not yet released)
3333
with the community.
3434
* Doc: describe the :ref:`developer-certificate-of-origin` process now applied
3535
on contributions.
36+
* Doc: add :ref:`add-new-maintainer` guide
3637

3738
.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
3839
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _add-new-maintainer:
2+
3+
Add a new maintainer
4+
====================
5+
6+
This document is a guide on how to set a new person as a maintainer for
7+
Modules project.
8+
9+
* Confirm he/she has read and understood the `Code of conduct`_ and
10+
:ref:`Technical charter<CHARTER>` of the project
11+
* Add to the `maintainer GitHub's team`_
12+
* Invite to the `modules-maintainers chat room`_
13+
* Subscribe to the `modules-maintainers mailing-list`_
14+
* Update *Current Roaster* section in :file:`GOVERNANCE.rst` file
15+
* Update *Authors* section in :file:`README.md` file
16+
* Make an announcement to:
17+
18+
* the modules-interest mailing-list
19+
* social media
20+
* and modules chat room
21+
22+
.. _Code of conduct: https://github.com/envmodules/modules?tab=coc-ov-file#readme
23+
24+
.. _maintainer GitHub's team: https://github.com/orgs/envmodules/teams/maintainers
25+
.. _modules-maintainers chat room: https://matrix.to/#/!AuNGUFFHUJpgQCfNRE:matrix.org
26+
.. _modules-maintainers mailing-list: https://sourceforge.net/projects/modules/lists/modules-maintainers
27+
28+
.. note:: To remove a maintainer from the group, reverse the above guidelines.
29+
30+
.. vim:set tabstop=2 shiftwidth=2 expandtab autoindent:

0 commit comments

Comments
 (0)