diff --git a/.github/ISSUE_TEMPLATE/01-normal-issue.md b/.github/ISSUE_TEMPLATE/01-normal-issue.md new file mode 100644 index 00000000..61e46c8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-normal-issue.md @@ -0,0 +1,17 @@ +--- +name: Normal issue +about: This is just a normal empty issue with a simple checklist +title: '' +labels: '' +assignees: '' + +--- + +## Issue checklist + +This is a simple checklist of things to bear in mind when creating a new issue. + +- [ ] **Describe the use-case**: As far as possible, use the pattern "As a [type of user], I would like [feature/functionality] to be able to do [specific action]." This helps identify the feature and the problem it addresses. +- [ ] **Indicate importance and urgency**: Use a scale (e.g., low, medium, high) to indicate the level of importance and urgency. +- [ ] **Work-around**: If there is a known work-around, describe it briefly. +- [ ] **Environment**: Describe the environment where the issue occurs (e.g., SDP version, K8S version, etc.). diff --git a/.github/ISSUE_TEMPLATE/02-bug_report.yml b/.github/ISSUE_TEMPLATE/02-bug_report.yml new file mode 100644 index 00000000..4eb2cffd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-bug_report.yml @@ -0,0 +1,54 @@ +--- +name: "🐛 Bug Report" +description: "If something isn't working as expected 🤔." +labels: ["type/bug"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible. + + - type: input + attributes: + label: Affected Stackable version + description: Which version of the Stackable Operator do you see this bug in? + +# - type: input + attributes: + label: Affected Apache Druid version + description: Which version of Apache Druid do you see this bug in? +# + - type: textarea + attributes: + label: Current and expected behavior + description: A clear and concise description of what the operator is doing and what you would expect. + validations: + required: true + + - type: textarea + attributes: + label: Possible solution + description: "If you have suggestions on a fix for the bug." + + - type: textarea + attributes: + label: Additional context + description: "Add any other context about the problem here. Or a screenshot if applicable." + + - type: textarea + attributes: + label: Environment + description: | + What type of kubernetes cluster you are running aginst (k3s/eks/aks/gke/other) and any other information about your environment? + placeholder: | + Examples: + Output of `kubectl version --short` + + - type: dropdown + attributes: + label: Would you like to work on fixing this bug? + description: | + **NOTE**: Let us know if you would like to submit a PR for this. We are more than happy to help you through the process. + options: + - "yes" + - "no" + - "maybe" diff --git a/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md b/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md index 0081b520..bc008c91 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md +++ b/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md @@ -1,4 +1,4 @@ -# Check and Update Getting Started Script +## Check and Update Getting Started Script