Merge pull request #624 from cisagov/ab/add-code-owners

Add code owners instructions and added to owners list
This commit is contained in:
Brandon Lenz 2023-05-24 11:59:26 -04:00 committed by GitHub
commit baf5f58b67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 1 deletions

6
.github/CODEOWNERS vendored
View file

@ -1,3 +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
docs/* @dotgov
# Default owners for all files
* @abroddrick
# Owners for documentation
docs/* @cisagov/dotgov

View file

@ -34,6 +34,8 @@ cf login -a api.fr.cloud.gov --sso
**Note:** As mentioned in the [Login documentation](https://developers.login.gov/testing/), the sandbox Login account is different account from your regular, production Login account. If you have not created a Login account for the sandbox before, you will need to create a new account first.
- [ ] Optional- add yourself as a codeowner if desired. See the [Developer readme](https://github.com/cisagov/getgov/blob/main/docs/developer/README.md) for how to do this and what it does.
### Steps for the onboarder
- [ ] Add the onboardee to cloud.gov org (cisa-getgov-prototyping)
- [ ] Setup a [developer specific space for the new developer](#setting-up-developer-sandbox)

View file

@ -81,6 +81,22 @@ 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.
## Adding to CODEOWNERS (optional)
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](../../.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:
```diff
- * @abroddrick
+ * @abroddrick @YourGitHubUser
```
3. Create a pull request to finalize your changes
## Viewing Logs
If you run via `docker-compose up`, you'll see the logs in your terminal.