From 296bc911b0458cb36f68bc9625b55b84c394d393 Mon Sep 17 00:00:00 2001 From: Curtis Robert Date: Mon, 27 Nov 2023 09:21:34 -0800 Subject: [PATCH] [chore] Fix CONTRIBUTING.md directions for adding a code owner (#29512) In my [last update](https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/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. --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 883d551293ee..ce68529fc767 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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