From a987de0c19d13b285bdafbc9e35bd1da8bd59ccf Mon Sep 17 00:00:00 2001 From: Alysia Broddrick Date: Wed, 17 May 2023 11:50:41 -0700 Subject: [PATCH 1/6] update codeowners file including tech lead --- .github/CODEOWNERS | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index bd2239e69..8e3c6d91b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1,4 @@ # 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 \ No newline at end of file +* @abroddrick +docs/* @DotGov From 9ed15bc1a8b94f78d5e603747916e0f742db2a82 Mon Sep 17 00:00:00 2001 From: Alysia Broddrick Date: Wed, 17 May 2023 11:55:40 -0700 Subject: [PATCH 2/6] update codeowners cisagov tag --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 8e3c6d91b..af56b635f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ # 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 * @abroddrick -docs/* @DotGov +docs/* @cisagov/dotgov From cc1438b0e7d80ecf4aa9800b4ab5d72942e09d85 Mon Sep 17 00:00:00 2001 From: Alysia Broddrick Date: Wed, 17 May 2023 12:11:56 -0700 Subject: [PATCH 3/6] add section on adding a codeowner --- docs/developer/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/developer/README.md b/docs/developer/README.md index a5e1d312e..54cf6e9f2 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -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. +## 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 If you run via `docker-compose up`, you'll see the logs in your terminal. From 5243f575250b50bf53bec297b9dd70a672d8f766 Mon Sep 17 00:00:00 2001 From: Alysia Broddrick Date: Wed, 17 May 2023 12:13:16 -0700 Subject: [PATCH 4/6] added optional checkbox for adding codeowner --- .github/ISSUE_TEMPLATE/developer-onboarding.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/developer-onboarding.md b/.github/ISSUE_TEMPLATE/developer-onboarding.md index b8f102685..74af9ef60 100644 --- a/.github/ISSUE_TEMPLATE/developer-onboarding.md +++ b/.github/ISSUE_TEMPLATE/developer-onboarding.md @@ -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) From f69cd985f0a59a77ac4f7e396d6653116a17cf37 Mon Sep 17 00:00:00 2001 From: Alysia Broddrick Date: Wed, 17 May 2023 12:15:53 -0700 Subject: [PATCH 5/6] fixed typo --- docs/developer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 54cf6e9f2..2a13cf58b 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -83,7 +83,7 @@ The endpoint /admin can be used to view and manage site content, including but n ## 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: +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: 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: From 7d70fb40e0dbf0f3ca6fb8812f5bb1afe0036f62 Mon Sep 17 00:00:00 2001 From: brandonlenz Date: Wed, 24 May 2023 11:08:57 -0400 Subject: [PATCH 6/6] PR Feedback: - Link to official documentation - Link to CODEOWNERS file - Add comments to CODEOWNERS for clarity at a brief glance - Markdown formatting --- .github/CODEOWNERS | 3 +++ docs/developer/README.md | 15 +++++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) 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