Skip to content

Commit

Permalink
doc: add *add-new-maintainer* guide
Browse files Browse the repository at this point in the history
Signed-off-by: Xavier Delaruelle <[email protected]>
  • Loading branch information
xdelaruelle committed Feb 3, 2025
1 parent 5f37d94 commit c4b0f96
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Modules 5.6.0 (not yet released)
with the community.
* Doc: describe the :ref:`developer-certificate-of-origin` process now applied
on contributions.
* Doc: add :ref:`add-new-maintainer` guide

.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org
Expand Down
30 changes: 30 additions & 0 deletions doc/source/devel/add-new-maintainer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _add-new-maintainer:

Add a new maintainer
====================

This document is a guide on how to set a new person as a maintainer for
Modules project.

* Confirm he/she has read and understood the `Code of conduct`_ and
:ref:`Technical charter<CHARTER>` of the project
* Add to the `maintainer GitHub's team`_
* Invite to the `modules-maintainers chat room`_
* Subscribe to the `modules-maintainers mailing-list`_
* Update *Current Roaster* section in :file:`GOVERNANCE.rst` file
* Update *Authors* section in :file:`README.md` file
* Make an announcement to:

* the modules-interest mailing-list
* social media
* and modules chat room

.. _Code of conduct: https://github.com/envmodules/modules?tab=coc-ov-file#readme

.. _maintainer GitHub's team: https://github.com/orgs/envmodules/teams/maintainers
.. _modules-maintainers chat room: https://matrix.to/#/!AuNGUFFHUJpgQCfNRE:matrix.org
.. _modules-maintainers mailing-list: https://sourceforge.net/projects/modules/lists/modules-maintainers

.. note:: To remove a maintainer from the group, reverse the above guidelines.

.. vim:set tabstop=2 shiftwidth=2 expandtab autoindent:

0 comments on commit c4b0f96

Please sign in to comment.