From 9470e1982630df3511d649c0b396c6cedaa32ba2 Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Wed, 12 Jun 2024 15:32:38 -0400 Subject: [PATCH 1/8] chore: update PR template Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 42 ++++++++++++++++++++------------ 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c694fd77fe..d26b82f421 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,29 +14,39 @@ Changelog: ## Types of changes What types of changes does your code introduce to Zowe Explorer? -_Put an `x` in the boxes that apply_ +_Put an `x` in all boxes that apply._ -- [ ] Bugfix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Enhancement (non-breaking change which adds or improves functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Updates to Documentation or Tests (if none of the other choices apply) +- [ ] Documentation (Markdown, README updates) +- [ ] Test cases (unit, integration, and/or end-to-end tests) +- [ ] Other (please specify above in "Proposed changes" section) ## Checklist -_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer_ +_Put an `x` in all boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer._ + +**General** - [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/zowe-explorer-vscode/wiki/Best-Practices:-Contributor-Guidance) wiki -- [ ] PR title follows [Conventional Commits Guidelines](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) -- [ ] PR Description is included -- [ ] gif or screenshot is included if visual changes are made -- [ ] `yarn workspace vscode-extension-for-zowe vscode:prepublish` has been executed -- [ ] All checks have passed (DCO, Jenkins and Code Coverage) -- [ ] I have added unit test and it is passing -- [ ] I have added integration test and it is passing -- [ ] There is coverage for the code that I have added -- [ ] I have tested it manually and there are no regressions found -- [ ] I have added necessary documentation (if appropriate) -- [ ] Any PR dependencies have been merged and published (if appropriate) +- [ ] PR title follows the [Conventional Commits Guidelines](https://www.conventionalcommits.org/en/v1.0.0/) +- [ ] PR description is included +- [ ] All PR dependencies have been merged and published (if applicable) +- [ ] All checks have passed (DCO, Codecov, SonarCloud) + +**Testing** + +- [ ] I have added new test cases and they are passing +- [ ] There is pre-existing coverage for the code that I have added +- [ ] I have manually tested the changes + +**Publishing** + +- [ ] I have added documentation (if applicable) +- [ ] A GIF or screenshot is included in the PR for visual changes + - [ ] (optional) the GIF/screenshot with the new behavior should be added to Zowe Docs +- [ ] These changes may need ported to the appropriate branches (e.g., `next` or a previous LTS branch) ## Further comments From eee88882b6fe6124fc685d2cdccb7555f545964f Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Wed, 12 Jun 2024 16:16:48 -0400 Subject: [PATCH 2/8] chore: remove unneeded items in PR template Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d26b82f421..d60591d2b0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -30,23 +30,20 @@ _Put an `x` in all boxes that apply. You can also fill these out after creating **General** - [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/zowe-explorer-vscode/wiki/Best-Practices:-Contributor-Guidance) wiki -- [ ] PR title follows the [Conventional Commits Guidelines](https://www.conventionalcommits.org/en/v1.0.0/) -- [ ] PR description is included - [ ] All PR dependencies have been merged and published (if applicable) -- [ ] All checks have passed (DCO, Codecov, SonarCloud) +- [ ] A GIF or screenshot is included in the PR for visual changes **Testing** +- [ ] There is coverage for the code that I have added - [ ] I have added new test cases and they are passing -- [ ] There is pre-existing coverage for the code that I have added - [ ] I have manually tested the changes **Publishing** -- [ ] I have added documentation (if applicable) -- [ ] A GIF or screenshot is included in the PR for visual changes - - [ ] (optional) the GIF/screenshot with the new behavior should be added to Zowe Docs -- [ ] These changes may need ported to the appropriate branches (e.g., `next` or a previous LTS branch) +- [ ] I have added developer documentation (if applicable) +- [ ] Documentation should be added to Zowe Docs +- [ ] These changes may need ported to the appropriate branches (list here): ## Further comments From 690b829fae0b906537e0987621a782a5e84b184f Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Thu, 13 Jun 2024 10:20:32 -0400 Subject: [PATCH 3/8] chore: adjust PR template sections, add back prepublish cmd Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d60591d2b0..74bc3c324d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -32,14 +32,15 @@ _Put an `x` in all boxes that apply. You can also fill these out after creating - [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/zowe-explorer-vscode/wiki/Best-Practices:-Contributor-Guidance) wiki - [ ] All PR dependencies have been merged and published (if applicable) - [ ] A GIF or screenshot is included in the PR for visual changes +- [ ] `yarn workspace vscode-extension-for-zowe vscode:prepublish` has been executed -**Testing** +**Code coverage** - [ ] There is coverage for the code that I have added - [ ] I have added new test cases and they are passing - [ ] I have manually tested the changes -**Publishing** +**Deployment** - [ ] I have added developer documentation (if applicable) - [ ] Documentation should be added to Zowe Docs From 378cb7322d6abd5e77a3d36693eb476d5b3ec6a1 Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Tue, 18 Jun 2024 10:18:21 -0400 Subject: [PATCH 4/8] fix(template): Clarify pre-publish command for ZE version Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 74bc3c324d..d3aa3b7a9c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -32,7 +32,9 @@ _Put an `x` in all boxes that apply. You can also fill these out after creating - [ ] I have read the [CONTRIBUTOR GUIDANCE](https://github.com/zowe/zowe-explorer-vscode/wiki/Best-Practices:-Contributor-Guidance) wiki - [ ] All PR dependencies have been merged and published (if applicable) - [ ] A GIF or screenshot is included in the PR for visual changes -- [ ] `yarn workspace vscode-extension-for-zowe vscode:prepublish` has been executed +- [ ] The pre-publish command has been executed: + - **v2 and below:** `yarn workspace vscode-extension-for-zowe vscode:prepublish` + - **v3:** `pnpm --filter vscode-extension-for-zowe vscode:prepublish` **Code coverage** From 4a1d6c1ef857b799b62fb2c7f8680ad717e2259b Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Tue, 18 Jun 2024 10:22:16 -0400 Subject: [PATCH 5/8] fix(template): Remove 'Test cases' from types of changes Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d3aa3b7a9c..f32c961fde 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,7 +20,6 @@ _Put an `x` in all boxes that apply._ - [ ] Enhancement (non-breaking change which adds or improves functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation (Markdown, README updates) -- [ ] Test cases (unit, integration, and/or end-to-end tests) - [ ] Other (please specify above in "Proposed changes" section) ## Checklist From 467e0e2f4bc4a6316000daf80bae9f9da6692f96 Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Tue, 18 Jun 2024 13:19:28 -0400 Subject: [PATCH 6/8] chore(template): Add to documentation checklist item Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f32c961fde..71f337826f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -45,6 +45,8 @@ _Put an `x` in all boxes that apply. You can also fill these out after creating - [ ] I have added developer documentation (if applicable) - [ ] Documentation should be added to Zowe Docs + - If you're an outside contributor, please contact @anaxceron (ana.ceron@broadcom.com) to coordinate documentation. + - Otherwise, please check with the rest of the squad about any needed documentation before merging. - [ ] These changes may need ported to the appropriate branches (list here): ## Further comments From 64f9d4d803f4973a7f7937ad4fdea3c421ede73c Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Thu, 20 Jun 2024 09:48:26 -0400 Subject: [PATCH 7/8] refactor(template): Address feedback on PR Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 71f337826f..bdc2f70265 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,8 +4,8 @@ ## Release Notes - - + + Milestone: @@ -13,18 +13,17 @@ Changelog: ## Types of changes -What types of changes does your code introduce to Zowe Explorer? -_Put an `x` in all boxes that apply._ + - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] Enhancement (non-breaking change which adds or improves functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Breaking change (a change that would cause existing functionality to not work as expected) - [ ] Documentation (Markdown, README updates) - [ ] Other (please specify above in "Proposed changes" section) ## Checklist -_Put an `x` in all boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer._ + **General** @@ -51,4 +50,4 @@ _Put an `x` in all boxes that apply. You can also fill these out after creating ## Further comments - + From 682e4191eb5615ebf21c5c2e92b6262db88b18ff Mon Sep 17 00:00:00 2001 From: Trae Yelovich Date: Thu, 20 Jun 2024 12:08:49 -0400 Subject: [PATCH 8/8] refactor(template): Replace contact info w/ zowe-doc Slack channel Signed-off-by: Trae Yelovich --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bdc2f70265..1fd6b0ac00 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -44,7 +44,7 @@ Changelog: - [ ] I have added developer documentation (if applicable) - [ ] Documentation should be added to Zowe Docs - - If you're an outside contributor, please contact @anaxceron (ana.ceron@broadcom.com) to coordinate documentation. + - If you're an outside contributor, please post in the [#zowe-doc Slack channel](https://openmainframeproject.slack.com/archives/CC961JYMQ) to coordinate documentation. - Otherwise, please check with the rest of the squad about any needed documentation before merging. - [ ] These changes may need ported to the appropriate branches (list here):