From e91fc4351f4c008705a3c5ab9b0ad70ea8670a4b Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Mon, 24 Mar 2025 15:13:42 +0100 Subject: [PATCH 1/2] Update issue templates --- .../.github/ISSUE_TEMPLATE/01-normal-issue.md | 17 +++++++++ ...bug_report.yml.j2 => 02-bug_report.yml.j2} | 0 .../.github/ISSUE_TEMPLATE/new_version.md.j2 | 35 ------------------- .../.github/ISSUE_TEMPLATE/normal-issue.md | 16 --------- 4 files changed, 17 insertions(+), 51 deletions(-) create mode 100644 template/.github/ISSUE_TEMPLATE/01-normal-issue.md rename template/.github/ISSUE_TEMPLATE/{bug_report.yml.j2 => 02-bug_report.yml.j2} (100%) delete mode 100644 template/.github/ISSUE_TEMPLATE/new_version.md.j2 delete mode 100644 template/.github/ISSUE_TEMPLATE/normal-issue.md diff --git a/template/.github/ISSUE_TEMPLATE/01-normal-issue.md b/template/.github/ISSUE_TEMPLATE/01-normal-issue.md new file mode 100644 index 00000000..61e46c8c --- /dev/null +++ b/template/.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/template/.github/ISSUE_TEMPLATE/bug_report.yml.j2 b/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 similarity index 100% rename from template/.github/ISSUE_TEMPLATE/bug_report.yml.j2 rename to template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 diff --git a/template/.github/ISSUE_TEMPLATE/new_version.md.j2 b/template/.github/ISSUE_TEMPLATE/new_version.md.j2 deleted file mode 100644 index 60fada27..00000000 --- a/template/.github/ISSUE_TEMPLATE/new_version.md.j2 +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: New Version -about: Request support for a new product version -title: "[NEW VERSION]" -labels: '' -assignees: '' - ---- - -## Which new version of {[ operator.pretty_string }] should we support? - -Please specify the version, version range or version numbers to support, please also add these to the issue title - -## Additional information - -If possible, provide a link to release notes/changelog - -## Changes required - -Are there any upstream changes that we need to support? -e.g. new features, changed features, deprecated features etc. - -## Implementation checklist - - - -- [ ] Update the Docker image -- [ ] Update documentation to include supported version(s) -- [ ] Update and test getting started guide with updated version(s) -- [ ] Update operator to support the new version (if needed) -- [ ] Update integration tests to test use the new versions (in addition or replacing old versions -- [ ] Update examples to use new versions diff --git a/template/.github/ISSUE_TEMPLATE/normal-issue.md b/template/.github/ISSUE_TEMPLATE/normal-issue.md deleted file mode 100644 index a518ec71..00000000 --- a/template/.github/ISSUE_TEMPLATE/normal-issue.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -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 is possible. For instance, using the pattern "As a XXXX, I would like XXXX to be able to do XXXX" helps to identify the feature as well as the problem it is intended to address. -- [ ] Indicate an approximate level of importance and urgency. -- [ ] Indicate if there is a known work-around until such time as the issue has been implemented. From 554415035acc0db0fee24cae6b92b65882944c22 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Sat, 3 May 2025 00:31:54 +0200 Subject: [PATCH 2/2] Hopefully fix syntax error/yamllint --- template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 b/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 index 3f084bc5..110ec4c9 100644 --- a/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 +++ b/template/.github/ISSUE_TEMPLATE/02-bug_report.yml.j2 @@ -12,12 +12,12 @@ body: label: Affected Stackable version description: Which version of the Stackable Operator do you see this bug in? -{[% if operator.has_product | default(true) %}] +# {[% if operator.has_product | default(true) %}] - type: input attributes: label: Affected {[ operator.pretty_string }] version description: Which version of {[ operator.pretty_string }] do you see this bug in? -{[% endif %}] +# {[% endif %}] - type: textarea attributes: