michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: clarify role of CODEOWNERS and MAINTAINERS files

Browse source 
Change docs to use MAINTAINERS file as the main file for managing code
areas and 'ownership'.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2023-11-15 11:40:00 -05:00
commit 538abf3332
3 changed files with 13 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CODEOWNERS
View file

@ -11,7 +11,12 @@
# add others as needed. # add others as needed.
# Do not use wildcard on all source yet # 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/aspeed/ @aspeeddylan
/soc/arm/atmel_sam/common/*_sam4l_*.c @nandojve /soc/arm/atmel_sam/common/*_sam4l_*.c @nandojve

4
doc/contribute/guidelines.rst
View file

@ -651,8 +651,8 @@ workflow here:
request for the ``main`` branch. The title and message from your commit request for the ``main`` branch. The title and message from your commit
message should appear as well. message should appear as well.
#. GitHub will assign one or more suggested reviewers (based on the #. A bot will assign one or more suggested reviewers (based on the
CODEOWNERS file in the repo). If you are a project member, you can MAINTAINERS file in the repo). If you are a project member, you can
select additional reviewers now too. select additional reviewers now too.
#. Click on the submit button and your pull request is sent and awaits #. Click on the submit button and your pull request is sent and awaits

9
doc/project/dev_env_and_tools.rst
View file

@ -20,10 +20,11 @@ and linked to any relevant :ref:`bug or feature tracking issues<bug_reporting>`
The Zephyr project uses GitHub for code reviews and Git tree management. When 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 submitting a change or an enhancement to any Zephyr component, a developer
should use GitHub. GitHub automatically assigns a responsible reviewer on a should use GitHub. GitHub Actions automatically assigns a responsible reviewer
component basis, as defined in the :zephyr_file:`CODEOWNERS` file stored with the code on a component basis, as defined in the :zephyr_file:`MAINTAINERS.yml` file
tree in the Zephyr project repository. A limited set of release managers are stored with the code tree in the Zephyr project repository. A limited set of
allowed to merge a pull request into the main branch once reviews are complete. release managers are allowed to merge a pull request into the main branch once
reviews are complete.
.. _review_time: .. _review_time: