From 691a7f92152ce33f037a110199fa0093ee575c01 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Mon, 18 Dec 2023 12:31:53 +0000 Subject: [PATCH 1/6] CLOUDP-215956: Convert our bug report issue on GitHub to forms --- .github/ISSUE_TEMPLATE/bug_report.yml | 101 ++++++++++++++++++++++++++ README.md | 21 +++++- 2 files changed, 119 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..75ff4f30d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,101 @@ +name: Bug Report [Recommended Template] +description: Something unexpected happen? Report an error, crash, or an incorrect behavior here. +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Thank you for opening an issue. **These GitHub issues** are only for community reporting and assistance; as such, we don't have a guaranteed SLA. + + **If your issue relates to Terraform itself**, please open it in the [Terraform repository](https://github.com/hashicorp/terraform/issues). + + **If you have an active MongoDB Atlas Support contract**, the best way for us to assist you with the Terraform MongoDB Atlas Provider is through a support ticket. + + **Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. + Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md). + + + - type: input + id: provider_version + attributes: + label: Provider Version + description: What provider version are you running? + placeholder: "Example: v1.13.1" + validations: + required: true + + - type: input + id: tf_version + attributes: + label: Terraform Version + description: What Terraform version are you running? + placeholder: "Example: v1.6.6" + validations: + required: true + + - type: dropdown + id: download + attributes: + label: Terraform Edition + options: + - Terraform Open Source (OSS) + - Terraform Enterprise + - Terraform Cloud + default: 0 + validations: + required: true + + - type: textarea + id: current_behaviour + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + + - type: textarea + id: tf_config + attributes: + label: Terraform configuration to reproduce the issue + description: Please copy and paste your Terraform configuration. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs + description: Additional logs that can help us investigating the issue + render: hcl + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. If the issue has been reported add a reaction, i.e. +1, to the issue. + options: + - label: I have searched the existing issues + required: true diff --git a/README.md b/README.md index 6fc353c0af..033207944e 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,25 @@ See [Troubleshooting](website/docs/troubleshooting.html.markdown). ## Developing the Provider See [CONTRIBUTING.md](./CONTRIBUTING.md). -## Autoclose stale issues and PRs +## Issues + +### Autoclose stale issues and PRs +- After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 7 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` +- After 5 more days of no activity we automatically close the issue/PR. + +### One-click reproducible issues principle +Our support will prioritise issues that contain all the required information that follows the following principles: + +* We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. + * This means that you should kindly **provide all the required instructions**. This includes but not limited to: + * Terraform Atlas provider version used to reproduce the issue + * Terraform version used to reproduce the issue + * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. +* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: + * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. + * If external components are required to replicate it, please make sure you also provides instructions on those parts. +* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment -- After 7 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 7 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` -- After 7 more days of no activity we automatically close the issue/PR. ## Thanks From a965d22e6fc133cfce784103faba42537eeb882b Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Mon, 18 Dec 2023 12:35:55 +0000 Subject: [PATCH 2/6] updated link --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 75ff4f30d0..ef961877d3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -12,7 +12,7 @@ body: **If you have an active MongoDB Atlas Support contract**, the best way for us to assist you with the Terraform MongoDB Atlas Provider is through a support ticket. **Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. - Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md). + Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md#one-click-reproducible-issues-principle). - type: input From fd700b787d62121e3e76be230746c3a34cbd1bb4 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Mon, 18 Dec 2023 12:40:31 +0000 Subject: [PATCH 3/6] Deprecate old template --- .github/ISSUE_TEMPLATE/Bug_Report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md index ddc26cec8f..1c68a16622 100644 --- a/.github/ISSUE_TEMPLATE/Bug_Report.md +++ b/.github/ISSUE_TEMPLATE/Bug_Report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug report [Deprecated] about: Something unexpected happen? Report an error, crash, or an incorrect behavior here. --- From c39e1213ec16d3f151ddb85189f68f29fc1c4a98 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Mon, 18 Dec 2023 12:52:27 +0000 Subject: [PATCH 4/6] update --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ef961877d3..f92f38dc31 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -14,7 +14,14 @@ body: **Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md#one-click-reproducible-issues-principle). - + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. If the issue has been reported add a reaction, i.e. +1, to the issue. + options: + - label: I have searched the existing issues + required: true + - type: input id: provider_version attributes: From 415b0e2ba136bbb8d7ea5acbd956fe17e8a112aa Mon Sep 17 00:00:00 2001 From: Andrea Angiolillo Date: Tue, 19 Dec 2023 11:12:52 +0000 Subject: [PATCH 5/6] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Agustin Bettati --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f92f38dc31..c591900aaa 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: Bug Report [Recommended Template] +name: Bug report [Recommended Template] description: Something unexpected happen? Report an error, crash, or an incorrect behavior here. title: "[Bug]: " body: From f779c58cb2c4768512544fa90b4ae1d113be9a45 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 11:23:43 +0000 Subject: [PATCH 6/6] Addressed PR comments --- .github/ISSUE_TEMPLATE/Bug_Report.md | 15 ++------------- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- README.md | 2 +- 3 files changed, 4 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md index 1c68a16622..9403cb8ce7 100644 --- a/.github/ISSUE_TEMPLATE/Bug_Report.md +++ b/.github/ISSUE_TEMPLATE/Bug_Report.md @@ -14,19 +14,8 @@ Thank you for opening an issue. **These GitHub issues** are only for community r **Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. Our support will **prioritise** issues that contain **all the required** information that follows the **"one-click reproducible issues" principle** (see below). -**Please also note:** We try to keep the Terraform MongoDB Atlas Provider issue tracker **reserved for bug reports**. Please ensure you **check open and closed issues first** to ensure your issue hasn't already been reported (if it has been reported add a reaction, i.e. +1, to the issue). - -### "One-click reproducible issues" principle - -* We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. - * This means that you should kindly **provide all the required instructions**. This includes but not limited to: - * Terraform Atlas provider version used to reproduce the issue - * Terraform version used to reproduce the issue - * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. -* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: - * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. - * If external components are required to replicate it, please make sure you also provides instructions on those parts. -* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment +**Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. +Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md#one-click-reproducible-issues-principle). ### Terraform CLI and Terraform MongoDB Atlas Provider Version diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c591900aaa..1576eb5f43 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -94,7 +94,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + description: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/README.md b/README.md index 033207944e..507f3059a5 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md). ## Issues ### Autoclose stale issues and PRs -- After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 7 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` +- After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 5 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 5 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` - After 5 more days of no activity we automatically close the issue/PR. ### One-click reproducible issues principle