diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index af56b635f..3d7614620 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,7 @@ # For more information on CODEOWNERS, see the documentation: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners +# Default owners for all files * @abroddrick + +# Owners for documentation docs/* @cisagov/dotgov diff --git a/docs/developer/README.md b/docs/developer/README.md index 2a13cf58b..d96fa7253 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -83,14 +83,17 @@ The endpoint /admin can be used to view and manage site content, including but n ## Adding to CODEOWNERS (optional) -The CODEOWNERS file sets the tagged individuals as default PR reviewers on any commit regarding the content specified. An asterisk indicates a user will be added as PR reviewer for all files in the repo, while "subfolder/*" indicates a particular folder for which a user(s) will be added as default PR reviewer. To add yourself as code owner for all files: +The CODEOWNERS file sets the tagged individuals as default reviewers on any Pull Request that changes files that they are marked as owners of. -1. Go to .github\CODEOWNERS -2. where you see "* @abroddrick" add a space followed by your github tag. For instance if your github username was @NewGithubUsername you would do the following: +1. Go to [.github\CODEOWNERS](../../.github/CODEOWNERS) +2. Following the [CODEOWNERS documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), add yourself as owner to files that you wish to be automatically requested as reviewer for. + + For example, if you wish to add yourself as a default reviewer for all pull requests, add your GitHub username to the same line as the `*` designator: -``` -* @abroddrick @NewGithubUsername -``` + ```diff + - * @abroddrick + + * @abroddrick @YourGitHubUser + ``` 3. Create a pull request to finalize your changes