zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-07-25 20:18:38 +02:00
Code Issues Projects Releases Packages Wiki Activity

PR Feedback:

Browse source 
- Link to official documentation
- Link to CODEOWNERS file
- Add comments to CODEOWNERS for clarity at a brief glance
- Markdown formatting
This commit is contained in:
brandonlenz 2023-05-24 11:08:57 -04:00
parent f69cd985f0
commit 7d70fb40e0
No known key found for this signature in database
GPG key ID: FC8818009789E370
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.github/CODEOWNERS vendored
View file

@ -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 # 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 * @abroddrick
# Owners for documentation
docs/* @cisagov/dotgov docs/* @cisagov/dotgov

15
docs/developer/README.md
View file

@ -83,14 +83,17 @@ The endpoint /admin can be used to view and manage site content, including but n
## Adding to CODEOWNERS (optional) ## 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 1. Go to [.github\CODEOWNERS](../../.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: 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:
``` ```diff
* @abroddrick @NewGithubUsername - * @abroddrick
``` + * @abroddrick @YourGitHubUser
```
3. Create a pull request to finalize your changes 3. Create a pull request to finalize your changes