docs/codeowners: Provide some relevant information about CODEOWNERS.

Some brief information in the contributing workflow to tell new
contributors about the CODEOWNERS file and what it achieves.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin 2025-09-05 11:42:34 -04:00 committed by Xiang Xiao
parent f8e5d07477
commit 897c79084f

View file

@ -265,6 +265,21 @@ squash before submitting the Pull Request:
happy, they may suggest squashing and merging again to make a single commit. In this case you would repeat steps
1 through 6.
.. note::
NuttX uses a ``CODEOWNERS`` file to help track which users are "experts"
on certain NuttX subsystems. Sometimes, this will result in certain
reviewers being automatically requested to review your PR if you have
modified a file they are marked as a "code owner" for. This is just to
help contributors get more relevant reviews from someone who knows the
subject area.
If you've created a new file, let's say for a driver, you can add yourself
as a code owner for that file by modifying ``.github/CODEOWNERS``. Read
the `GitHub documentation for CODEOWNERS
<https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners>`_
for more information.
How to Include the Suggestions on Your Pull Request?
====================================================