From 0df5cf1893ce09fd378675dc8f883c301bde4255 Mon Sep 17 00:00:00 2001 From: Sandrine Bailleux Date: Thu, 25 May 2023 15:55:11 +0200 Subject: [PATCH] docs: clarify maintainers election process Add a new page in TF-A documentation for clarifying the process to elect a new maintainer. This builds on top of the Trusted Firmware process [1], with the following TF-A specific details: - Must have contributed to the project for at least a couple of years. - Must dedicate at least 2 hours a week for maintainer duties. - Details about the election process. In particular, setting a one-calendar-week deadline for other maintainers to raise objections. [1] https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/ Signed-off-by: Sandrine Bailleux Change-Id: Ibef08bbbd4d18cd7aea13e01ba570972a7ee808d --- docs/about/maintainers.rst | 4 +++ docs/process/index.rst | 1 + docs/process/maintenance.rst | 55 ++++++++++++++++++++++++++++++++++++ 3 files changed, 60 insertions(+) create mode 100644 docs/process/maintenance.rst diff --git a/docs/about/maintainers.rst b/docs/about/maintainers.rst index accb01a36..b591f2a8e 100644 --- a/docs/about/maintainers.rst +++ b/docs/about/maintainers.rst @@ -17,6 +17,10 @@ Review Guidelines`. Maintainers ----------- +.. note:: + If you wish to become a maintainer for TF-A project, please refer to the + :ref:`Project Maintenance Processes`. + :|M|: Dan Handley :|G|: `danh-arm`_ :|M|: Soby Mathew diff --git a/docs/process/index.rst b/docs/process/index.rst index 7914a4e27..9b669c020 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -13,4 +13,5 @@ Processes & Policies contributing code-review-guidelines faq + maintenance security-hardening diff --git a/docs/process/maintenance.rst b/docs/process/maintenance.rst new file mode 100644 index 000000000..45aada260 --- /dev/null +++ b/docs/process/maintenance.rst @@ -0,0 +1,55 @@ +Project Maintenance Processes +============================= + +Trusted Firmware-A (TF-A) project follows the generic `trustedfirmware.org +Project Maintenance Process`_. The present document complements it by defining +TF-A project-specific decisions. + +How to become a maintainer? +--------------------------- + +Qualifying Criteria +~~~~~~~~~~~~~~~~~~~ + +To be elligible to become a maintainer for TF-A project, all criteria outlined +`here`_ must be fullfilled. These are: + +- Being an active member of the project for at least a couple of years. + +- Having contributed a substantial number of non-trivial and high-quality + patches. + +- Having reviewed a substantial number of non-trivial patches, preferably in the + generic layer, with high-quality constructive feedback. + +- Behaving in a professional and polite way, with the best interests of the + project at heart. + +- Showing a strong will to improve the project and to do the right thing, rather + than going for the quick and easy path. + +- Participating in design discussions on the development mailing list and during + TF-A tech forums calls. + +- Having appropriate bandwidth (minimum 2 hours per week) to deal with the workload. + +Election Process +~~~~~~~~~~~~~~~~ + +To put an individual's name up for election, + +#. Send an email to all existing TF-A maintainers, asking whether they have any + objections to this individual becoming a TF-A maintainer. + +#. Give existing maintainers one calendar week to participate in the discussion. + +#. If there are objections, the existing maintainers should try to resolve them + amongst themselves. If they cannot, this should be escalated to the + trustedfirmware.org Technical Steering Commitee (TSC). + +#. If there are no (more) objections, announce the news on the TF-A mailing list + and update the list of maintainers on the :ref:`Project + Maintenance` page. + +.. _trustedfirmware.org Project Maintenance Process: https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/ +.. _here: https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/#how-to-become-a-maintainer