diff --git a/docs/about/maintainers.rst b/docs/about/maintainers.rst index 0287d6cee476a7ab22d8f7655046091b8b3351a2..accb01a367dad7c5130fc4bd9388fa0af1e3614f 100644 --- a/docs/about/maintainers.rst +++ b/docs/about/maintainers.rst @@ -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** @@ -980,5 +979,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/ diff --git a/docs/process/code-review-guidelines.rst b/docs/process/code-review-guidelines.rst index 67a211f7530e7c549f79c69f72985a50a1145de7..ccdd110e107062c5b3b357c1b7302618d6713f9d 100644 --- a/docs/process/code-review-guidelines.rst +++ b/docs/process/code-review-guidelines.rst @@ -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/