From cb6be2df0567f67d22c3095071f4093b60f8c36e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Sat, 9 Jul 2022 12:55:28 +0200 Subject: [PATCH 1/6] Update bug report template to use new YAML issue templating functionality --- .github/ISSUE_TEMPLATE/bug_report.md | 36 -------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 67 ++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 36 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3de59fe1c3b..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[Bug] Bug description" -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** - -Input: -```java -/*Code being processed by spoon and leading to the bug.*/ -``` - -Processing with Spoon: -```java -/*Code calling spoon on the input and triggering the bug.*/ -``` - -Output: -```java -/*Output code or stacktrace if unexpected Exception is raised*/ -``` - -Note that you can also open a pull request reproducing the issue and reference that, instead of writing additional information here. - -**Operating system, JDK and Spoon version used** - -* OS: -* JDK: -* Spoon version: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000000..a32cb5b07ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,67 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: Provide a general description of the bug, in plain text. Use the dedicated fields below for code snippets. + placeholder: Description of the bug + validations: + required: true + - type: textarea + id: java-input + attributes: + label: Source code you are trying to analyze/transform + description: Provide a minimal example of source code you are trying to analyze/transform that causes the bug to appear. + placeholder: System.out.println("Hello, world!"); + render: Java + validations: + required: false + - type: textarea + id: spoon-code + attributes: + label: Source code for your Spoon processing + description: Provide your processing code that uses Spoon and causes the bug to appear. This will be automatically formatted, so no need for backticks. + placeholder: System.out.println("Hello, world!"); + render: Java + validations: + required: false + - type: textarea + id: output + attributes: + label: Output + description: The output that spoon provides, or a stacktrace if it crashes. This will be automatically formatted, so no need for backticks. + placeholder: System.out.println("Hello, world!"); + render: Java + validations: + required: false + - type: textarea + id: expected-output + attributes: + label: Expected output + description: If you know what kind of output you expect to get, please provide it here. This will be automatically formatted, so no need for backticks. + placeholder: System.out.println("Hello, world!"); + render: Java + validations: + required: false + - type: textarea + id: version + attributes: + label: Spoon Version + description: What version of Spoon are you using? Please note that we only actively support the latest major release. If you are using an older major version, your issue may be closed as non-actionable. + placeholder: 10.1.0 + validations: + required: true + - type: textarea + id: os + attributes: + label: What operating system are you using? + validations: + required: true \ No newline at end of file From 5aa32114546a89fcc93bbb52fd5a6b6cc77383de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Sat, 9 Jul 2022 23:06:42 +0200 Subject: [PATCH 2/6] Clarify actual output Co-authored-by: I-Al-Istannen --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index a32cb5b07ac..20062050745 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -36,7 +36,7 @@ body: - type: textarea id: output attributes: - label: Output + label: Actual output description: The output that spoon provides, or a stacktrace if it crashes. This will be automatically formatted, so no need for backticks. placeholder: System.out.println("Hello, world!"); render: Java From e775d78fd0f44c2ffd7bb49338a6c1b7f95ee076 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Sat, 9 Jul 2022 23:08:11 +0200 Subject: [PATCH 3/6] Add note about automatic formatting --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 20062050745..acbec98c7bf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -19,7 +19,7 @@ body: id: java-input attributes: label: Source code you are trying to analyze/transform - description: Provide a minimal example of source code you are trying to analyze/transform that causes the bug to appear. + description: Provide a minimal example of source code you are trying to analyze/transform that causes the bug to appear. This will be automatically formatted, so no need for backticks. placeholder: System.out.println("Hello, world!"); render: Java validations: From 21ec3af3a61c9de8e6d31b9002cb316b74450c4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Sat, 9 Jul 2022 23:08:41 +0200 Subject: [PATCH 4/6] Improve ridiculous placeholder for Spoon processing code Co-authored-by: I-Al-Istannen --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index acbec98c7bf..0562f7a9f59 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -29,7 +29,7 @@ body: attributes: label: Source code for your Spoon processing description: Provide your processing code that uses Spoon and causes the bug to appear. This will be automatically formatted, so no need for backticks. - placeholder: System.out.println("Hello, world!"); + placeholder: Launcher launcher = new Launcher(); render: Java validations: required: false From 2f33f2f967f97fda9a287753ea2c61cf0b6af98c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Mon, 11 Jul 2022 17:48:40 +0200 Subject: [PATCH 5/6] Improve Spoon version placeholder --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 0562f7a9f59..c1264a7312b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -56,7 +56,7 @@ body: attributes: label: Spoon Version description: What version of Spoon are you using? Please note that we only actively support the latest major release. If you are using an older major version, your issue may be closed as non-actionable. - placeholder: 10.1.0 + placeholder: X.Y.Z validations: required: true - type: textarea From 5e3d6b04c231df6153a65b04f5ea37b2ec435778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Lars=C3=A9n?= Date: Mon, 11 Jul 2022 17:49:18 +0200 Subject: [PATCH 6/6] Add dropdown for JVM version --- .github/ISSUE_TEMPLATE/bug_report.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index c1264a7312b..542c11fe316 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -59,6 +59,22 @@ body: placeholder: X.Y.Z validations: required: true + - type: dropdown + id: jvm-version + attributes: + label: JVM Version + description: Which JVM version are you running Spoon with? Note that Spoon is built for Java 11+, and we cannot maintain support for older versions. + options: + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + validations: + required: true - type: textarea id: os attributes: