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.

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 #182

Merged
merged 11 commits into from
Dec 20, 2023
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Bug report
name: Bug report [Deprecated]
about: Create a report to help us improve
title: ''
labels: ''
Expand Down
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Bug report [Recommended Template]
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 you have an active MongoDB Atlas Support contract**, the best way for us to assist you with the AWS CDK MongoDB Atlas 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: package_version
attributes:
label: CDK package version
description: What CDK Atlas package version are you running?
placeholder: "Example: v2.0.0"
validations:
required: true

- type: input
id: cfn_resource_version
attributes:
label: CFN Resource version
description: What CFN resource version are you using in your AWS account?
andreaangiolillo marked this conversation as resolved.
Show resolved Hide resolved
placeholder: "Example: v1.6.6"
validations:
required: true

- type: input
id: cfn_resource_region
attributes:
label: CFN Resource Region
description: In which AWS Region are you running your CFN stack?
placeholder: "US-EAST-1"
andreaangiolillo marked this conversation as resolved.
Show resolved Hide resolved
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: AWS CDK code to reproduce the issue
description: Please copy and paste your cdk code. This will be automatically formatted into code, so no need for backticks.
render: typescript
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: cdk synth
description: Please copy and paste the outout of [`cdk synth`](https://cdkworkshop.com/30-python/20-create-project/400-synth.html)
render: shell
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](../../CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: CFN/CDK Atlas Feature Request
url: https://feedback.mongodb.com/forums/924145-atlas?category_id=392596
about: Request a feature or up-vote an existing suggestion!
- name: MongoDB Atlas Support
url: https://support.mongodb.com/
about: Support is provided under MongoDB Atlas support plans. Please submit support questions within the Atlas UI.
- name: MongoDB Atlas
url: https://www.mongodb.com/cloud/atlas
about: Learn more about MongoDB Atlas
19 changes: 19 additions & 0 deletions API.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,22 @@ Here are some examples of how to use this template:

## Contributing
See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.

## 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 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
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
Loading