zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-14 00:27:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

add section on adding a codeowner

Browse source
This commit is contained in:
Alysia Broddrick 2023-05-17 12:11:56 -07:00
parent 9ed15bc1a8
commit cc1438b0e7
No known key found for this signature in database
GPG key ID: 03917052CD0F06B7
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/developer/README.md
View file

@ -81,6 +81,19 @@ The endpoint /admin can be used to view and manage site content, including but n
5. In the browser, navigate to /admins. To verify that all is working correctly, under "domain applications" you should see fake domains with various fake statuses. 5. In the browser, navigate to /admins. To verify that all is working correctly, under "domain applications" you should see fake domains with various fake statuses.
## Adding to CODEOWNERS (optional)
The CODEOWNERS file set the tagged individuals as default PR reviewers on any commit regarding the content specify. "*" 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:
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:
```
* @abroddrick @NewGithubUsername
```
3. Create a pull request to finalize your changes
## Viewing Logs ## Viewing Logs
If you run via `docker-compose up`, you'll see the logs in your terminal. If you run via `docker-compose up`, you'll see the logs in your terminal.