fdcavalcanti commented on PR #16962:
URL: https://github.com/apache/nuttx/pull/16962#issuecomment-3245111485
Here are some good information about the code owners file and its
interaction on Github. I summarized with GPT.
I like that we can make code owners groups
### 🔹 What is CODEOWNERS?
- A `CODEOWNERS` file defines individuals or teams responsible for specific
files/paths.
- When changes affect those files, GitHub **automatically requests reviews**
from the owners.
- Helps ensure the right maintainers review the right parts of the code.
---
### 🔹 Key Details
**1. File Placement & Branch**
- Must be in one of:
- `/CODEOWNERS` (root)
- `.github/CODEOWNERS`
- `docs/CODEOWNERS`
- GitHub only uses the *first* one it finds (in the order above).
- Ownership rules are taken from the base branch of the PR.
**2. Syntax & Patterns**
- Same style as `.gitignore`: `pattern @owner`.
- Owners can be `@username` or `@org/team`.
- Last matching rule takes precedence.
- Unsupported: negation (`!`), character ranges (`[]`), escaping `#`.
- Case-sensitive paths.
**3. Owner Requirements**
- Owners must have **write access**.
- Best practice: assign **teams**, not individuals.
**4. Branch Protection**
- Enable **“Require review from Code Owners”** in branch protection.
- Any listed owner’s approval counts.
**5. Workflow Security**
- Useful to restrict sensitive files like **GitHub Actions workflows**.
---
### 🔹 Steps for NuttX Integration
1. **Create the file**
- Place `CODEOWNERS` in the repo root (simplest choice).
2. **Define rules**
- Start broad:
```text
* @core-maintainers
```
- Then add more specific rules, e.g.:
```text
/drivers/** @driver-team
*.c @c-maintainers
```
3. **Check permissions**
- Ensure all listed users/teams have **write access**.
4. **Enable branch protection**
- Require reviews from code owners on `main`.
5. **Commit & push**
- Push to default branch.
- Verify that GitHub shows “Owned by …” on file hovers and that PRs
auto-request reviews.
6. **Validate syntax**
- Errors show in GitHub’s UI.
- Can also check via REST API:
```
GET /repos/{owner}/{repo}/codeowners/errors
```
7. **Maintain over time**
- Update as modules and maintainers evolve.
- Revisit rules periodically.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
