chore: CLOUDP-215956 - Convert our bug report issue on GitHub to forms #1767
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
Comment on lines
64
to
81
| ## 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!``` | ||
| - 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.
I moved One-click reproducible issues principle from the template to our readme file. The new template references to this section
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| name: Bug report | |||
| name: Bug report [Deprecated] | |||
There was a problem hiding this comment.
Deprecating the old template
AgustinBettati
approved these changes
Dec 19, 2023
oarbusi
approved these changes
Dec 19, 2023
| 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.
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.
We do. good point xD I will update it
There was a problem hiding this comment.
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.
adding here #1771
Co-authored-by: Agustin Bettati <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Ticket: CLOUDP-215956
This PR updates our issue template to use GitHub forms. We plan to keep the old template until GitHub form is not GA.
This is the new customer experience when filing an issue on our repo:
After selecting the new template (example)
After pressing the create button
Example
Type of change:
Required Checklist:
Further comments