-
Notifications
You must be signed in to change notification settings - Fork 178
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.
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
chore: CLOUDP-215956 - Convert our bug report issue on GitHub to forms #1767
Changes from 5 commits
691a7f9
e78aa60
a965d22
fd700b7
c39e121
415b0e2
f779c58
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
name: Bug Report [Recommended Template] | ||
andreaangiolillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: Something unexpected happen? Report an error, crash, or an incorrect behavior here. | ||
title: "[Bug]: <your-title>" | ||
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#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: | ||
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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not sure if we have a code of conduct for this project, but probably we need to change the link There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We do. good point xD I will update it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh wow, just discovered that we don't have it. I will add it in a follow up PR (same one that we have in atlascli https://github.com/mongodb/mongodb-atlas-cli/edit/master/CODE_OF_CONDUCT.md) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. adding here #1771 |
||
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 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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!``` | ||
oarbusi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I moved One-click reproducible issues principle from the template to our readme file. The new template references to this section |
||
|
||
- 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 | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deprecating the old template