doc: Updates template issue with clearer guidelines. #1510
Conversation
marcosuma
changed the title
marcosuma
changed the title
.github/ISSUE_TEMPLATE/Bug_Report.md
Outdated
| In order to follow the **"one-click reproducible issues" principle**, please follow these guidelines: | ||
| * We should be able to run `terraform plan` and `terraform apply` **with no errors**. | ||
| * Configurations that return errors when executed will be de-prioritised in favour of the ones that succeed. | ||
| * 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. |
There was a problem hiding this comment.
this list is missing the following info:
- Terraform Atlas provider version used to reproduce the issue
- Terraform version used to reproduce the issue
- Confirmation if Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment
There was a problem hiding this comment.
Regarding:
- Terraform Atlas provider version used to reproduce the issue
- Terraform version used to reproduce the issue
maybe we can clarify that the version.tf file is also needed (i.e. the provider specification).
I think I specified somewhere else that the whole configuration is needed in order for us to be one-click-away from reproducing the issue; but I'll clarify that.
- Confirmation if Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment
Ok sure, this one I missed it.
There was a problem hiding this comment.
Changes updated. Let me know if that's ok with you.
Co-authored-by: Andrea Angiolillo <[email protected]>
There was a problem hiding this comment.
LGTM.
General feedback (no changes are needed, I'm happy to see if the current template works before making any changes): I think the template is too verbose as a user may not want to read all of this info before opening an issue. In the future, we might consider a more concise template that lists the top 3-4 pieces of information users must provide when opening an issue.
Co-authored-by: Agustin Bettati <[email protected]>
Co-authored-by: Agustin Bettati <[email protected]>
|
|
@AgustinBettati updated with your corrections. Thank you! @andreaangiolillo I agree with your comment, I think too it's verbose but I am not sure if in this specific case it's a problem. This is my rationale. I don't expect actually all users will read it all, but when they don't comply to our guidelines from now on we'll be able to claim that the issue is not ready to be worked. At some point the most frequent issue creators will know our new guidelines. FYI @andreaangiolillo @AgustinBettati I made few other changes or restructuring it. |
Description
Please include a summary of the fix/feature/change, including any relevant motivation and context.
Link to any related issue(s): Engineering Proposal
https://jira.mongodb.org/browse/CLOUDP-202434
Type of change:
Required Checklist:
Further comments