mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-07-24 11:38:39 +02:00
PR Feedback:
- 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:
parent
f69cd985f0
commit
7d70fb40e0
2 changed files with 12 additions and 6 deletions
|
@ -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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue