Skip to content

Commit

Permalink
[chore] Fix CONTRIBUTING.md directions for adding a code owner (#29512)
Browse files Browse the repository at this point in the history
In my [last
update](#29451)
I incorrectly removed a note about adding your username to the
`.github/CODEOWNERS` file. I assumed it would be done automatically
since the file has a header saying it's generated automatically, but I
was incorrect. The file is generated by the `make gengithub` command
which is run by users, not a GitHub workflow.
  • Loading branch information
crobert-1 committed Nov 27, 2023
1 parent 49bc0b7 commit 296bc91
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,12 @@ Code Ownership is ultimately up to the judgement of the existing Code Owners and

### How to become a Code Owner

To become a Code Owner, open a PR adding your GitHub username to the active codeowners entry in the component's `metadata.yaml` file.
To become a Code Owner, open a PR with the following changes:

1. Add your GitHub username to the active codeowners entry in the component's `metadata.yaml` file.
2. Run the command `make gengithub`. This will add your GitHub username to the component's row in the [CODEOWNERS](.github/CODEOWNERS) file. You can do this update manually if the command is unsuccessful.
* Note: A GitHub [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) must be configured for this command to work.

Be sure to tag the existing Code Owners, if any, within the PR to ensure they receive a notification.

## Makefile Guidelines
Expand Down

0 comments on commit 296bc91

Please sign in to comment.