Merge changes from topic "sb/maintainters-process" into integration

* changes:
  docs: clarify maintainers election process
  docs: consolidate code review process documentation
This commit is contained in:
Sandrine Bailleux 2023-06-01 13:42:16 +02:00 committed by TrustedFirmware Code Review
commit ff31094a0d
4 changed files with 93 additions and 15 deletions

View file

@ -2,12 +2,11 @@ Project Maintenance
===================
Trusted Firmware-A (TF-A) is an open governance community project. All
contributions are ultimately merged by the maintainers listed below. Technical
ownership of most parts of the codebase falls on the code owners listed
below. An acknowledgement from these code owners is required before the
maintainers merge a contribution.
contributions are reviewed and merged by the community members listed below.
More details may be found in the `Project Maintenance Process`_ document.
For more details on the roles of `maintainers`, `code owners` and general
information about code reviews in TF-A project, please refer to the :ref:`Code
Review Guidelines`.
.. |M| replace:: **Mail**
.. |G| replace:: **GitHub ID**
@ -18,6 +17,10 @@ More details may be found in the `Project Maintenance Process`_ document.
Maintainers
-----------
.. note::
If you wish to become a maintainer for TF-A project, please refer to the
:ref:`Project Maintenance Processes`.
:|M|: Dan Handley <dan.handley@arm.com>
:|G|: `danh-arm`_
:|M|: Soby Mathew <soby.mathew@arm.com>
@ -980,5 +983,3 @@ Conventional Changelog Extensions
.. _bytefire: https://github.com/bytefire
.. _rupsin01: https://github.com/rupsin01
.. _jimmy-brisson: https://github.com/theotherjimmy
.. _Project Maintenance Process: https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/

View file

@ -1,11 +1,6 @@
Code Review Guidelines
======================
This document provides TF-A specific details about the project's code review
process. It should be read in conjunction with the `Project Maintenance
Process`_, which it supplements.
Why do we do code reviews?
--------------------------
@ -23,8 +18,34 @@ Code reviews are meant to benefit everyone through team work. It is not about
unfairly criticizing or belittling the work of any contributor.
Good practices
--------------
Overview of the code review process
-----------------------------------
All contributions to Trusted Firmware-A project are reviewed by the community to
ensure they meet the project's expectations before they get merged, according to
the `Project Maintenance Process`_ defined for all `Trusted Firmware` projects.
Technical ownership of most parts of the codebase falls on the :ref:`code
owners`. All patches are ultimately merged by the :ref:`maintainers`.
Approval of a patch is tracked using Gerrit `labels`. For a patch to be merged,
it must get all of the following votes:
- At least one ``Code-Owner-Review+1`` up-vote, and no ``Code-Owner-Review-1``
down-vote.
- At least one ``Maintainer-Review+1`` up-vote, and no ``Maintainer-Review-1``
down-vote.
- ``Verified+1`` vote applied by the automated Continuous Integration (CI)
system.
Note that, in some instances, the maintainers might give a waiver for some of
the CI failures and manually override the ``Verified+1`` score.
Good practices for all reviewers
--------------------------------
To ensure the code review gives the greatest possible benefit, participants in
the project should:
@ -211,6 +232,6 @@ concerns, questions, or any other type of blocking comment, they should set
--------------
*Copyright (c) 2020, Arm Limited. All rights reserved.*
*Copyright (c) 2020-2023, Arm Limited. All rights reserved.*
.. _Project Maintenance Process: https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/

View file

@ -13,4 +13,5 @@ Processes & Policies
contributing
code-review-guidelines
faq
maintenance
security-hardening

View file

@ -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<maintainers>` 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