From c5428c498a6a46f2393fafb09ea0f38b4c822ee9 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Wed, 18 Dec 2024 07:29:21 +0100 Subject: [PATCH] doc: desc. Modules governance --- .hunspell.en.dic | 1 + NEWS.rst | 1 + doc/source/GOVERNANCE.rst | 51 +++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 4 files changed, 54 insertions(+) create mode 100644 doc/source/GOVERNANCE.rst diff --git a/.hunspell.en.dic b/.hunspell.en.dic index 22f4347cf..11221ba5b 100644 --- a/.hunspell.en.dic +++ b/.hunspell.en.dic @@ -1206,3 +1206,4 @@ nb envmodules lightsteelblue HowTos +xdelaruelle diff --git a/NEWS.rst b/NEWS.rst index 3d352a3c8..1b3dacd8b 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -24,6 +24,7 @@ Modules 5.6.0 (not yet released) * Doc: create *Developer HowTos* section on documentation website to group development how-to guides. * Doc: add :ref:`acknowledgments` page in the documentation. +* Doc: describe :ref:`GOVERNANCE`. .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md diff --git a/doc/source/GOVERNANCE.rst b/doc/source/GOVERNANCE.rst new file mode 100644 index 000000000..f64bd63d8 --- /dev/null +++ b/doc/source/GOVERNANCE.rst @@ -0,0 +1,51 @@ +.. _GOVERNANCE: + +Modules Governance +================== + +This document describes the governance model of Modules project with the +following roles defined: + +* *Project Leads*: form the Technical Steering Committee of Modules project +* *Collaborators*: irregular contributors to Modules project +* *Former Members*: former notable contributors and project leads + +Project Leads +------------- + +Role +~~~~ + +* Merge contributions +* Set project's technical direction +* Create Modules releases +* Do administrative operations + +Current Roster +~~~~~~~~~~~~~~ + +* Xavier Delaruelle (`@xdelaruelle`_) + +.. _@xdelaruelle: https://github.com/xdelaruelle + +Collaborators +------------- + +*Collaborators* are irregular contributors to Modules project. They are +expected to adhere to the quality practices of the project described in the +:ref:`CONTRIBUTING` guide. + +*Collaborators* are acknowledged in `GitHub contributor tracking`_ and +:ref:`Modules release notes`. + +.. _GitHub contributor tracking: https://github.com/envmodules/modules/graphs/contributors + +Former Members +-------------- + +*Former members* are those who notably contributed to Modules project and +Modules would not be what it is without their contributions. *Former members* +have no specific role in the governance of the Modules project. Instead, they +are acknowledged in `GitHub contributor tracking`_, the :ref:`Modules +documentation` and cited in :ref:`Modules release +notes`. diff --git a/doc/source/index.rst b/doc/source/index.rst index 7a6ffb76b..b29cd4482 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -119,6 +119,7 @@ automatically configured to the correct architecture. CONTRIBUTING devel design + GOVERNANCE acknowledgments