From 91390c083259964601407c4caaf419c64560529b Mon Sep 17 00:00:00 2001 From: rcskosir Date: Wed, 28 Feb 2024 14:46:28 -0800 Subject: [PATCH 01/16] updated PR guide; add PR template --- .../pull_request_template.md | 0 contributing/topics/guide-opening-a-pr.md | 69 +++++++++++++++++-- 2 files changed, 62 insertions(+), 7 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/contributing/topics/guide-opening-a-pr.md b/contributing/topics/guide-opening-a-pr.md index 76ecb7d1d02b..63a923db2497 100755 --- a/contributing/topics/guide-opening-a-pr.md +++ b/contributing/topics/guide-opening-a-pr.md @@ -16,11 +16,11 @@ As a general rule, the smaller the PR the quicker it's merged - as such when upg We also recommend not opening a PR based on your `main` branch. By doing this any changed pushed to the PR may inadvertently be also pushed to your `main` branch without warning. -Due to the high volume of PR's on the project and to ensure maintainers are able to focus on changes which are ready to review, please do not open Draft PRs or work that is not yet ready to be reviewed. +Due to the high volume of PRs on the project and to ensure maintainers are able to focus on changes which are ready to review, please do not open Draft PRs or work that is not yet ready to be reviewed. ## Process -Pull Requests generally go through a number of phrases which vary slightly depending on what's being changed. +Pull Requests generally go through a number of phases which vary slightly depending on what's being changed. The following guides cover the more common scenarios we see: @@ -46,7 +46,7 @@ In general, Pull Requests which add/change either code or SDK's go through the f * Don't send the PR from your `main` branch. * The PR Title is obvious/clear about what it's changing (see `Title` below). * The PR Body contains a summary of what/why is included (see `Body` below). -* any linked Issues +* any linked Issues (see `Body` below) ### Title @@ -73,12 +73,67 @@ Examples of poorly written PR titles: - `add cosmos property` - `support encryption, local_authentication_enabled properties` -### Description +### Body -A PR should include a brief description of the reason for the PR, what it is doing, what it is trying to accomplish, and anything relevant for a reviewer to know. It also helps to paste the output from running the accpetance tests. +Our PR template will include a community note and a PR checklist. It will have additional checkboxes for new feature submissions, updating existing resources, documentation changes depending on the type of PR. Finally it will have a description section, linked issues and the changelog. -It should also link to any related issues/PRs and include the following for any issues that it will resolve: +#### Community Note + +* Please vote on this PR by adding a :thumbsup: [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original PR to help the community and maintainers prioritize for review +* Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review + + #### PR Checklist + +- [ ] Have you followed the guidelines in our [Contributing Documentation](../contributing/README.md)? +- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? +- [ ] Have you used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work? +Example: +“`resource_name_here` - description of change e.g. adding property `new_property_name_here`” +- [ ] Do your changes close any open issues? If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. + + + +#### New Feature Submissions + +- [ ] Does your submission include Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass? (if this is not possible for any reason, please include details of why below) + +#### Changes to existing Resource / Data Source + +- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? (This may be covered by linking to an issue above, but may benefit from additional explanation) +- [ ] Have you written new tests for your resource or datasource changes? +- [ ] Have you successfully run tests with your changes locally? If not, please provide details on testing challenges that prevented you running the tests. + +#### Documentation Changes + +- [ ] Documentation is written in International English. +- [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source. + +#### Description + + + + +#### Related Issue(s) + Use [linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) here like "fixes", "closes", "resolves", etc: ``` - fixes #1234,#5678 + Fixes #1234, fixes #5678, fixes #9101 ``` +#### Change Log + +[Changelog Format](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md) + + + +* `azurerm_resource` - support for the `thing1` property [GH-00000] + + + +- [ ] Bug Fix +- [ ] New Feature + + +> [!NOTE] If this PR changes meaningfully during the course of review please update the title and description as required. + + + From fca839f03582f7a763a93cef3cf96455f6912663 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Wed, 28 Feb 2024 14:53:32 -0800 Subject: [PATCH 02/16] add pr template --- .../pull_request_template.md | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index e69de29bb2d1..7a18596aab06 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,80 @@ +# All Submissions + + +## Community Note + + + +* Please vote on this PR by adding a :thumbsup: [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original PR to help the community and maintainers prioritize for review +* Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review + + +## PR Checklist + + +- [ ] Have you followed the guidelines in our [Contributing Documentation](../contributing/README.md)? +- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? +- [ ] Have you used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work? +Example: +“`resource_name_here` - description of change e.g. adding property `new_property_name_here`” +- [ ] Do your changes close any open issues? If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. + + + + + +## New Feature Submissions + + +- [ ] Does your submission include Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass? (if this is not possible for any reason, please include details of why below) + + +## Changes to existing Resource / Data Source + + +- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? (This may be covered by linking to an issue above, but may benefit from additional explanation) +- [ ] Have you written new tests for your resource or datasource changes? +- [ ] Have you successfully run tests with your changes locally? If not, please provide details on testing challenges that prevented you running the tests. + + +## Documentation Changes + + +- [ ] Documentation is written in International English. +- [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source. + + +## Description + + + + + + + +## Related Issue(s) +Fixes #0000 +## Change Log + + +[Changelog Format](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md) + + + + + +* `azurerm_resource` - support for the `thing1` property [GH-00000] + + + + + +- [ ] Bug Fix +- [ ] New Feature + + + + +> [!NOTE] If this PR changes meaningfully during the course of review please update the title and description as required. + + From f0ef3dff5f510c36cd5e1505be59a2edbbe3626c Mon Sep 17 00:00:00 2001 From: rcskosir Date: Thu, 29 Feb 2024 08:04:49 -0800 Subject: [PATCH 03/16] updated spacing --- .../PULL_REQUEST_TEMPLATE/pull_request_template.md | 13 +------------ contributing/topics/guide-opening-a-pr.md | 2 +- 2 files changed, 2 insertions(+), 13 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 7a18596aab06..508418e93390 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,17 +1,14 @@ -# All Submissions + ## Community Note - - * Please vote on this PR by adding a :thumbsup: [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original PR to help the community and maintainers prioritize for review * Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review ## PR Checklist - - [ ] Have you followed the guidelines in our [Contributing Documentation](../contributing/README.md)? - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? - [ ] Have you used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work? @@ -25,13 +22,11 @@ Example: ## New Feature Submissions - - [ ] Does your submission include Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass? (if this is not possible for any reason, please include details of why below) ## Changes to existing Resource / Data Source - - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? (This may be covered by linking to an issue above, but may benefit from additional explanation) - [ ] Have you written new tests for your resource or datasource changes? - [ ] Have you successfully run tests with your changes locally? If not, please provide details on testing challenges that prevented you running the tests. @@ -39,14 +34,12 @@ Example: ## Documentation Changes - - [ ] Documentation is written in International English. - [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source. ## Description - @@ -56,19 +49,15 @@ Example: Fixes #0000 ## Change Log - [Changelog Format](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md) - - * `azurerm_resource` - support for the `thing1` property [GH-00000] - - [ ] Bug Fix - [ ] New Feature diff --git a/contributing/topics/guide-opening-a-pr.md b/contributing/topics/guide-opening-a-pr.md index 63a923db2497..46cfee4ac58b 100755 --- a/contributing/topics/guide-opening-a-pr.md +++ b/contributing/topics/guide-opening-a-pr.md @@ -75,7 +75,7 @@ Examples of poorly written PR titles: ### Body -Our PR template will include a community note and a PR checklist. It will have additional checkboxes for new feature submissions, updating existing resources, documentation changes depending on the type of PR. Finally it will have a description section, linked issues and the changelog. +An example of our PR template is shown below. #### Community Note From 2f086c0813a30fb8928b109b15493b0a3cfe9f78 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Thu, 29 Feb 2024 08:48:25 -0800 Subject: [PATCH 04/16] added PR type enhancement --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 508418e93390..1ef4e7ba5e2d 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -60,6 +60,7 @@ Fixes #0000 - [ ] Bug Fix - [ ] New Feature +- [ ] Enhancement From b39a7caf5a117ed756d5955ff2cb964501160351 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Fri, 1 Mar 2024 10:53:56 -0800 Subject: [PATCH 05/16] updated based on PR comments --- .../pull_request_template.md | 24 ++++++++++--------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 1ef4e7ba5e2d..ba15c5a50137 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -9,12 +9,12 @@ ## PR Checklist -- [ ] Have you followed the guidelines in our [Contributing Documentation](../contributing/README.md)? -- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? -- [ ] Have you used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work? +- [ ] I have followed the guidelines in our [Contributing Documentation](../contributing/README.md). +- [ ] I have checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change. +- [ ] I have used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work. Example: “`resource_name_here` - description of change e.g. adding property `new_property_name_here`” -- [ ] Do your changes close any open issues? If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. +- [ ] I have checked if my changes close any open issues. If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. @@ -22,14 +22,14 @@ Example: ## New Feature Submissions -- [ ] Does your submission include Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass? (if this is not possible for any reason, please include details of why below) +- [ ] My submission includes Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass. (if this is not possible for any reason, please include details of why below) ## Changes to existing Resource / Data Source -- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? (This may be covered by linking to an issue above, but may benefit from additional explanation) -- [ ] Have you written new tests for your resource or datasource changes? -- [ ] Have you successfully run tests with your changes locally? If not, please provide details on testing challenges that prevented you running the tests. +- [ ] I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation). +- [ ] I have written new tests for my resource or datasource changes. +- [ ] I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests. ## Documentation Changes @@ -47,9 +47,9 @@ Example: ## Related Issue(s) Fixes #0000 -## Change Log -[Changelog Format](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md) +## Change Log +Below please provide what should go into the changelog (if anything) conforning to the [Changelog Format documentated here](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md). @@ -57,6 +57,7 @@ Fixes #0000 +This is a (please select all that apply): - [ ] Bug Fix - [ ] New Feature @@ -65,6 +66,7 @@ Fixes #0000 -> [!NOTE] If this PR changes meaningfully during the course of review please update the title and description as required. +> [!NOTE] +> If this PR changes meaningfully during the course of review please update the title and description as required. From 0d2d5e5ecef44ce87e2b42715d15390f4b6276d3 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Fri, 1 Mar 2024 10:56:07 -0800 Subject: [PATCH 06/16] fixed typos --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index ba15c5a50137..774eb23f709e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -49,7 +49,7 @@ Example: Fixes #0000 ## Change Log -Below please provide what should go into the changelog (if anything) conforning to the [Changelog Format documentated here](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md). +Below please provide what should go into the changelog (if anything) conforming to the [Changelog Format documented here](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md). From 814325bbe25f663b9437e224d5cfeb573f58207f Mon Sep 17 00:00:00 2001 From: rcskosir Date: Mon, 4 Mar 2024 09:20:39 -0800 Subject: [PATCH 07/16] updated with state migration --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 774eb23f709e..0402bc55b844 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -30,6 +30,7 @@ Example: - [ ] I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation). - [ ] I have written new tests for my resource or datasource changes. - [ ] I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests. +- [ ] (For changes that include a **state migration only**). I have manually tested the migration path between relevant versions of the provider. ## Documentation Changes @@ -40,10 +41,12 @@ Example: ## Description - - + +## Testing Evidence + ## Related Issue(s) Fixes #0000 From e3e2bc61617e2cbbd662d36c9a74a99434ee8bf0 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Mon, 11 Mar 2024 14:25:02 -0700 Subject: [PATCH 08/16] removed the subdirectory, single template --- .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md From 0c8a834b12eaa3979190a328d54fc4b79def712a Mon Sep 17 00:00:00 2001 From: rcskosir Date: Mon, 11 Mar 2024 15:02:02 -0700 Subject: [PATCH 09/16] updated relative links --- .github/pull_request_template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0402bc55b844..500cdc9fa1dc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,8 +9,8 @@ ## PR Checklist -- [ ] I have followed the guidelines in our [Contributing Documentation](../contributing/README.md). -- [ ] I have checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change. +- [ ] I have followed the guidelines in our [Contributing Documentation](../blob/main/contributing/README.md). +- [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change. - [ ] I have used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work. Example: “`resource_name_here` - description of change e.g. adding property `new_property_name_here`” @@ -22,7 +22,7 @@ Example: ## New Feature Submissions -- [ ] My submission includes Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass. (if this is not possible for any reason, please include details of why below) +- [ ] My submission includes Test coverage as described in the [Contribution Guide](../blob/main/contributing/topics/guide-new-resource.md) and the tests pass. (if this is not possible for any reason, please include details of why below) ## Changes to existing Resource / Data Source @@ -52,7 +52,7 @@ For state migrations please test the changes locally and provide details here, s Fixes #0000 ## Change Log -Below please provide what should go into the changelog (if anything) conforming to the [Changelog Format documented here](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md). +Below please provide what should go into the changelog (if anything) conforming to the [Changelog Format documented here](../blob/main/contributing/topics/maintainer-changelog.md). From 95c2b73ced30c46cbba10a2ae9dbab7bcd735b9e Mon Sep 17 00:00:00 2001 From: Renae Kosir <132920294+rcskosir@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:43:10 -0700 Subject: [PATCH 10/16] Update .github/pull_request_template.md remove 1 documentation checkbox Co-authored-by: kt --- .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 500cdc9fa1dc..da7b29dc0ff6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -35,7 +35,6 @@ Example: ## Documentation Changes -- [ ] Documentation is written in International English. - [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source. From 7a05fc0453a6e87a0f9cc2a2900f9c829348f3a6 Mon Sep 17 00:00:00 2001 From: Renae Kosir <132920294+rcskosir@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:43:27 -0700 Subject: [PATCH 11/16] Update .github/pull_request_template.md testing title update Co-authored-by: kt --- .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 da7b29dc0ff6..2daf27a49d02 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -42,7 +42,7 @@ Example: -## Testing Evidence +## Testing Logs/Evidence From ade272c3d82cedfda1fb16e4fdebc5a8a7267ec6 Mon Sep 17 00:00:00 2001 From: Renae Kosir <132920294+rcskosir@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:43:48 -0700 Subject: [PATCH 12/16] Update .github/pull_request_template.md New feature explanation Co-authored-by: kt --- .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 2daf27a49d02..09c4178711a1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -62,7 +62,7 @@ Below please provide what should go into the changelog (if anything) conforming This is a (please select all that apply): - [ ] Bug Fix -- [ ] New Feature +- [ ] New Feature (ie adding a service, resource, or data source) - [ ] Enhancement From c320c73ca65ada425a1cfcd89f519c1fe7a53df7 Mon Sep 17 00:00:00 2001 From: Renae Kosir <132920294+rcskosir@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:44:01 -0700 Subject: [PATCH 13/16] Update .github/pull_request_template.md breaking change checkbox Co-authored-by: kt --- .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 09c4178711a1..ac478944f0ed 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -64,7 +64,7 @@ This is a (please select all that apply): - [ ] Bug Fix - [ ] New Feature (ie adding a service, resource, or data source) - [ ] Enhancement - +- [ ] Breaking Change From a1d4d69de010edb70400a05219c58bf31098672f Mon Sep 17 00:00:00 2001 From: Renae Kosir <132920294+rcskosir@users.noreply.github.com> Date: Tue, 12 Mar 2024 16:44:52 -0700 Subject: [PATCH 14/16] Update .github/pull_request_template.md breaking change note Co-authored-by: kt --- .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 ac478944f0ed..758c8a2e5718 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -40,7 +40,9 @@ Example: ## Description - + ## Testing Logs/Evidence From 01569d8228cf0c725e0d0e89734a490607eddf24 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Tue, 12 Mar 2024 16:46:04 -0700 Subject: [PATCH 15/16] description to title --- .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 758c8a2e5718..9845d485695e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,7 +11,7 @@ - [ ] I have followed the guidelines in our [Contributing Documentation](../blob/main/contributing/README.md). - [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change. -- [ ] I have used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work. +- [ ] I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work. Example: “`resource_name_here` - description of change e.g. adding property `new_property_name_here`” - [ ] I have checked if my changes close any open issues. If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. From 8f68f6493929d1651825da11e77cd9a439e20e06 Mon Sep 17 00:00:00 2001 From: rcskosir Date: Wed, 13 Mar 2024 11:40:14 -0700 Subject: [PATCH 16/16] reorder PR checklist --- .github/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9845d485695e..202f45412dba 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,10 +11,10 @@ - [ ] I have followed the guidelines in our [Contributing Documentation](../blob/main/contributing/README.md). - [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change. -- [ ] I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work. -Example: -“`resource_name_here` - description of change e.g. adding property `new_property_name_here`” - [ ] I have checked if my changes close any open issues. If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below. +- [ ] I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work. +For example: “`resource_name_here` - description of change e.g. adding property `new_property_name_here`” +