doc: Updates template issue with clearer guidelines. (#1510)

* Updates template issue with clearer guidelines. * Update .github/ISSUE_TEMPLATE/Bug_Report.md Co-authored-by: Andrea Angiolillo <andrea.angiolillo@mongodb.com> * Update text. * Update .github/ISSUE_TEMPLATE/Bug_Report.md Co-authored-by: Agustin Bettati <bettatiagustin@gmail.com> * Update .github/ISSUE_TEMPLATE/Bug_Report.md Co-authored-by: Agustin Bettati <bettatiagustin@gmail.com> * Update text. --------- Co-authored-by: Andrea Angiolillo <andrea.angiolillo@mongodb.com> Co-authored-by: Agustin Bettati <bettatiagustin@gmail.com>
mongodb · Oct 16, 2023 · b581d84 · b581d84
1 parent 17a83f2
commit b581d84
Showing 1 changed file with 32 additions and 15 deletions.
diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md
@@ -6,14 +6,28 @@ about: Something unexpected happen? Report an error, crash, or an incorrect beha
 
 Hello!
 
-Thank you for opening an issue.  Please note that 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).  
+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 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](https://support.mongodb.com/).
+**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](https://support.mongodb.com/).
+
+**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
 
-Repository issues are only for community reporting and assistance.
--->
 
 ### Terraform CLI and Terraform MongoDB Atlas Provider Version
 <!---
@@ -23,26 +37,29 @@ If you are not running the latest version of Terraform and the MongoDB Atlas Pro
 -->
 
 ```hcl
-# Copy-paste your version info here
+# Copy-paste your version.tf and provider.tf (or equivalent) here
 ```
 
 ### Terraform Configuration File 
 <!--
-Paste the relevant parts of your Terraform MongoDB Atlas Provider configuration file info between the ``` marks below or consider creating a GitHub Gist with the information and share it here.
+Paste here all the required parts of your Terraform MongoDB Atlas Provider configuration file below. You can alternatively consider creating a [**GitHub Gist**](https://gist.github.com/) with the information and share it here.
 
-Please be sure to redact any sensitive information; common examples include API Keys, passwords, other secrets, or any items your project/business may consider sensitive such as hostnames or usernames.
+Share your configuration by **using variables**. Create a `variables.tf` file and share its content. Please be sure to redact any sensitive information; common examples include API Keys, passwords, other secrets, or any items your project/business may consider sensitive such as hostnames or usernames.
 -->
 
 ```hcl
-# Copy-paste your configuration info here
+# Copy-paste all your configuration (e.g. main.tf and variable.tf) info here
 ```
 
 ### Steps to Reproduce
-<!--
-Please list the full steps required to reproduce the issue, for example:
-1. `terraform init`
-2. `terraform apply`
--->
+
+Please be **as detailed as possible.**
+* If the issue **involves version changes** (e.g. `run plan with version 1.k.x then re-run with version 1.k.y`), please make sure you report the detailed sequence on commands to execute.
+* If the issue requires **changes from the UI**, please document them **preferably with screenshots**.
+
+```hcl
+# Write here the detailed list of required steps.
+```
 
 ### Expected Behavior
 <!--
@@ -56,7 +73,7 @@ What actually happened?
 
 ### Debug Output 
 <!--
-Note: Debug output can be incredibly helpful in narrowing down an issue but is not required.
+Note: Debug output can be incredibly helpful in narrowing down an issue.
 
 Full debug output can be obtained by running Terraform with the environment variable `TF_LOG=trace`. Please create either a GitHub Gist or attach a file containing the debug output. Please do _not_ paste the debug output in the issue, since debug output can be very long.