Skip to content

feat(codeowners): Initial CODEOWNERS setup #11397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

lucasssvaz
Copy link
Collaborator

@lucasssvaz lucasssvaz commented May 23, 2025

This pull request introduces a new CODEOWNERS file to the repository, specifying ownership rules for different parts of the ESP32 Arduino Core project. The file ensures that review requests are directed to the appropriate developers based on the file or directory being modified.

Other libraries and files can be added with time. This is only the initial setup.

Copy link
Contributor

github-actions bot commented May 23, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix(codeowners): Add teams":
    • summary looks too short

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello lucasssvaz, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 98ef1ef

@lucasssvaz
Copy link
Collaborator Author

@me-no-dev @SuGlider @P-R-O-C-H-Y @pedrominatel PTAL and see if you would like to change/add/remove something.

@rftafas @igrr @Parsaabasi Would you like to be code owners of any specific files ?

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lucasssvaz, I agree.

# Note that order matters. The last matching pattern will be used.

# The default owners are the active developers of the ESP32 Arduino Core.
# Refrain from using @espressif/arduino-esp32 to avoid spamming non-developers with review requests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's also possible to create a group or modify the list of people in arduino-esp32 group if it doesn't serve its purpose

Copy link
Collaborator Author

@lucasssvaz lucasssvaz May 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could create something like "espressif/arduino-devs" with only the main developers. Does it need to be created by one of the organization admins or can we do it ourselves ?

Edit: Created @espressif/arduino-devs. Pending parent team approval to give it write permissions to this repository.

* @lucasssvaz @me-no-dev @P-R-O-C-H-Y @SuGlider

# CI
/.github/ @lucasssvaz @me-no-dev @P-R-O-C-H-Y
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and optionally espressif/ci here, just in case some workflow has to be updated due to a security issue

Copy link
Collaborator Author

@lucasssvaz lucasssvaz May 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We change our CI files quite frequently. Wouldn't this spam the CI team with review notifications? I have never used CODEOWNERS before so I don't know. The idea is to enable the branch protection rule to require codeowners review and AFAIK this automatically requests the review of all owners.

@me-no-dev
Copy link
Member

Some libs are missing from the list. Is that intentional?

@lucasssvaz
Copy link
Collaborator Author

lucasssvaz commented May 27, 2025

Some libs are missing from the list. Is that intentional?

I just added the libs that I knew who the owner is. If there is anything missing just say so and I will add. By default anything that doesn't have a explicit ownership will be owned by @espressif/arduino-devs. This is supposed to be just an initial setup. For example, I will add the BLE ownership when I add the NimBLE support.

@lucasssvaz lucasssvaz added the Status: Blocked upstream 🛑 PR is waiting on upstream changes to be merged first label May 28, 2025
@lucasssvaz
Copy link
Collaborator Author

lucasssvaz commented May 28, 2025

Added suggestions. Just missing the parent team approval now.

image

@igrr Could you please take a look ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Blocked upstream 🛑 PR is waiting on upstream changes to be merged first Type: CI & Testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants