From a62477844689040b483775bb5ab5e5e25790dfa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Legrand?= Date: Mon, 15 Jul 2024 17:48:32 +0200 Subject: [PATCH 1/2] Update review-pr.md --- docs/content/contribute/review-pr.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/contribute/review-pr.md b/docs/content/contribute/review-pr.md index 284ce2723234..7b3d87eeb0b8 100644 --- a/docs/content/contribute/review-pr.md +++ b/docs/content/contribute/review-pr.md @@ -11,14 +11,14 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR). * is linked to a GitHub issue or an internal bug * if not, check the [issue tracker](https://github.com/hashicorp/terraform-provider-google/issues) to see whether the feature has already been requested and add the issues in the description, if any. * establishes clear context itself via title or description. -2. If the PR adds any new resource, ensure that the resource does not already exists in the [GA provider](https://github.com/hashicorp/terraform-provider-google) or [beta provider](https://github.com/hashicorp/terraform-provider-google-beta) +2. If the PR adds any new resource, ensure that the resource does not already exist in the [GA provider](https://github.com/hashicorp/terraform-provider-google) or [beta provider](https://github.com/hashicorp/terraform-provider-google-beta) 1. Read through all the changes in the PR, generated code in the downstreams and the API documentation to ensure that: 1. the resource schema added in the PR matches the API structure. 1. the features are added in the correct version * features only available in beta are not included in the GA google provider. * features added to the GA provider are also included in the beta provider -- beta should be a strict superset of GA. 1. no [breaking changes]({{< ref "/develop/breaking-changes/make-a-breaking-change" >}}) are introduced without a valid justification. Add the `override-breaking-change` label if there is a valid justification. - * remember to check for changes in default behaviour like changing the flags on delete! + * remember to check for changes in default behavior like changing the flags on delete! 1. verify the change **fully** resolves the linked issues, if any. If it does not, change the "Fixes" message to "Part of". 1. Check the tests added/modified to ensure that: 1. all fields added/updated in the PR appear in at least one test. @@ -46,4 +46,4 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR). 1. Check documentation to ensure 1. resouce-level and field-level documentation are generated correctly for MMv1-based resource 1. documentation is added manually for handwritten resources. -1. Check if release notes capture all changes in the PR, and are correctly formatted following the guidance in [write release notes]({{< ref "release-notes" >}}) before merge the PR. +1. Check if release notes capture all changes in the PR, and are correctly formatted following the guidance in [write release notes]({{< ref "release-notes" >}}) before merging the PR. From 58c4cfd69e502ccd90f532c6fb6100f18f7a07ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Legrand?= Date: Tue, 16 Jul 2024 20:10:10 +0200 Subject: [PATCH 2/2] Update review-pr.md --- docs/content/contribute/review-pr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/contribute/review-pr.md b/docs/content/contribute/review-pr.md index 7b3d87eeb0b8..b4508b814efe 100644 --- a/docs/content/contribute/review-pr.md +++ b/docs/content/contribute/review-pr.md @@ -18,7 +18,7 @@ This page provides guidelines for reviewing a Magic Modules pull request (PR). * features only available in beta are not included in the GA google provider. * features added to the GA provider are also included in the beta provider -- beta should be a strict superset of GA. 1. no [breaking changes]({{< ref "/develop/breaking-changes/make-a-breaking-change" >}}) are introduced without a valid justification. Add the `override-breaking-change` label if there is a valid justification. - * remember to check for changes in default behavior like changing the flags on delete! + * remember to check for changes in default behaviour like changing the flags on delete! 1. verify the change **fully** resolves the linked issues, if any. If it does not, change the "Fixes" message to "Part of". 1. Check the tests added/modified to ensure that: 1. all fields added/updated in the PR appear in at least one test.