Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Updates template issue with clearer guidelines. #1510

Merged
merged 6 commits into from
Oct 16, 2023
Merged

doc: Updates template issue with clearer guidelines. #1510

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b505e44
Updates template issue with clearer guidelines.
marcosuma Oct 6, 2023
9daf577
Update .github/ISSUE_TEMPLATE/Bug_Report.md
marcosuma Oct 14, 2023
c8f9982
Update text.
marcosuma Oct 16, 2023
0159aee
Update .github/ISSUE_TEMPLATE/Bug_Report.md
marcosuma Oct 16, 2023
54468cb
Update .github/ISSUE_TEMPLATE/Bug_Report.md
marcosuma Oct 16, 2023
7116256
Update text.
marcosuma Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,34 @@ 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 by using the **"one-click reproducible issues" principle**.

**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).

### Guidelines

In order to follow the **"one-click reproducible issues" principle**, please follow these guidelines:

* We should be able to make no changes to your provided script and **be able to run `terraform plan` and `terraform apply` with no errors**.
marcosuma marked this conversation as resolved.
Show resolved Hide resolved
* This means that you should kindly provide us the whole script contatining all the required instructions. This also includes but not limited to:
* Terraform Atlas provider version used to reproduce the issue
* Terraform version used to reproduce the issue
* Configurations that return errors when executed will be de-prioritised in favour of the ones that succeed.
marcosuma marked this conversation as resolved.
Show resolved Hide resolved
* Share your configuration by **using variables**. Create a `variables.tf` file and share its content.
* 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.

* If the issue requires **changes from the UI**, please document them preferably with screenshots
* 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.
* 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
<!---
Expand All @@ -28,7 +48,7 @@ If you are not running the latest version of Terraform and the MongoDB Atlas Pro

### 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.
-->
Expand Down
Loading