From 538abf3332e411de916670f538445385b2aff4a4 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Wed, 15 Nov 2023 11:40:00 -0500 Subject: [PATCH] doc: clarify role of CODEOWNERS and MAINTAINERS files Change docs to use MAINTAINERS file as the main file for managing code areas and 'ownership'. Signed-off-by: Anas Nashif --- CODEOWNERS | 7 ++++++- doc/contribute/guidelines.rst | 4 ++-- doc/project/dev_env_and_tools.rst | 9 +++++---- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index ab9197825c5..54f2b65933a 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -11,7 +11,12 @@ # add others as needed. # Do not use wildcard on all source yet -# * @galak @nashif +# +# +++++++++++ NOTE ++++++++++++++++ +# +# Please use the MAINTAINERS file to add yourself in an area or to add a new +# component or code. This file is going to be deprecated and currently only had +# entries that are not covered by the MAINTAINERS file. /soc/arm/aspeed/ @aspeeddylan /soc/arm/atmel_sam/common/*_sam4l_*.c @nandojve diff --git a/doc/contribute/guidelines.rst b/doc/contribute/guidelines.rst index ac88fa768ab..b3dd735dd42 100644 --- a/doc/contribute/guidelines.rst +++ b/doc/contribute/guidelines.rst @@ -651,8 +651,8 @@ workflow here: request for the ``main`` branch. The title and message from your commit message should appear as well. -#. GitHub will assign one or more suggested reviewers (based on the - CODEOWNERS file in the repo). If you are a project member, you can +#. A bot will assign one or more suggested reviewers (based on the + MAINTAINERS file in the repo). If you are a project member, you can select additional reviewers now too. #. Click on the submit button and your pull request is sent and awaits diff --git a/doc/project/dev_env_and_tools.rst b/doc/project/dev_env_and_tools.rst index 37356ec3232..8269e891d43 100644 --- a/doc/project/dev_env_and_tools.rst +++ b/doc/project/dev_env_and_tools.rst @@ -20,10 +20,11 @@ and linked to any relevant :ref:`bug or feature tracking issues` The Zephyr project uses GitHub for code reviews and Git tree management. When submitting a change or an enhancement to any Zephyr component, a developer -should use GitHub. GitHub automatically assigns a responsible reviewer on a -component basis, as defined in the :zephyr_file:`CODEOWNERS` file stored with the code -tree in the Zephyr project repository. A limited set of release managers are -allowed to merge a pull request into the main branch once reviews are complete. +should use GitHub. GitHub Actions automatically assigns a responsible reviewer +on a component basis, as defined in the :zephyr_file:`MAINTAINERS.yml` file +stored with the code tree in the Zephyr project repository. A limited set of +release managers are allowed to merge a pull request into the main branch once +reviews are complete. .. _review_time: