From 47c18776267273464254447be6b50a8d61b14e3e Mon Sep 17 00:00:00 2001 From: Vladimir Sitnikov Date: Sat, 24 Sep 2022 18:25:18 +0300 Subject: [PATCH] Add GitHub Issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 59 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 5 ++ .github/ISSUE_TEMPLATE/documentation.yaml | 27 +++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 58 ++++++++++++++++++ .github/ISSUE_TEMPLATE/regression.yaml | 59 +++++++++++++++++++ .../PULL_REQUEST_TEMPLATE.md | 0 ISSUE_TEMPLATE.md | 15 ----- 7 files changed, 208 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/regression.yaml rename PULL_REQUEST_TEMPLATE.md => .github/PULL_REQUEST_TEMPLATE.md (100%) delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000000..8e079b4fa5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,59 @@ +name: Bug report +description: Create a report and help us improve +labels: + - defect + - to-triage +body: + - type: markdown + attributes: + value: | + Please fill in all required fields with as many details as possible. + Read the [User manual](https://jmeter.apache.org/usermanual/index.html) and/or [Reference documentation](https://jmeter.apache.org/usermanual/component_reference.html) + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + Describe what you were expecting JMeter to do + placeholder: | + Here you can also attach log files, screenshots or a video + - type: textarea + id: actual + attributes: + label: Actual behavior + description: | + Describe what you observed JMeter did instead + placeholder: | + Here you can also attach log files (e.g. jmeter.log), screenshots or a video + - type: textarea + id: steps + attributes: + label: Steps to reproduce the problem + description: | + - If the problem relates to a third-party plugin, consider removing them first + placeholder: | + Here you can also attach log files, screenshots or a video + validations: + required: true + - type: input + id: jmeter-version + attributes: + label: JMeter Version + description: | + What JMeter version and edition did you use? + Note: While you can obviously continue using older versions of JMeter, it may well be that your bug is already fixed. If you're using an older version, please also try to reproduce the bug in the latest version of JMeter before reporting it. + placeholder: ex. JMeter 5.5 + validations: + required: true + - type: input + id: java-version + attributes: + label: Java Version + description: What JDK version and distribution did you use (use `java -version`) + placeholder: ex. openjdk version "17" 2021-09-14 + - type: input + id: os-version + attributes: + label: OS Version + description: What operating system version and distribution did you use (use e.g. `ver` on Windows) + placeholder: ex. Microsoft Windows [Version 10.0.22000.856] diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000000..04a0fb026db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: JMeter users mailing list + url: https://jmeter.apache.org/mail2.html + about: Please ask questions on JMeter usage on users mailing list (note that you need to subscribe first) diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 00000000000..66192ff73e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,27 @@ +name: Feedback about the manual +description: Found an issue with the documentation? +labels: + - documentation + - to-triage +body: + - type: markdown + attributes: + value: | + Please fill in all required fields with as many details as possible. + - type: input + id: url + attributes: + label: The documentation URL + placeholder: ex. https://jmeter.apache.org/usermanual/best-practices.html + validations: + required: true + - type: textarea + id: feedback + attributes: + label: Feedback + description: | + Describe what issue with the documentation you've found + placeholder: | + Here you can also attach log files, screenshots or a video + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000000..d3a52265e22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,58 @@ +name: Feature Request +description: Suggest an idea +labels: + - enhancement + - to-triage +body: + - type: markdown + attributes: + value: | + Please describe the use-case you have. This will better help us understand the context in which you're looking for a new feature. + - type: textarea + id: use-case + attributes: + label: Use case + description: | + Please describe the use-case you have. This will better help us understand the context in which you're looking for a new feature. + placeholder: Describe the use-case here + validations: + required: true + - type: textarea + id: solution + attributes: + label: Possible solution + description: | + Please describe a possible solution you'd like to see in JMeter, ideally with example code. + Please note, it's not always easy to describe a good solution. Describing the use-case above is much more important to us. + placeholder: Describe the possible solution here. + validations: + required: false + - type: textarea + id: workarounds + attributes: + label: Possible workarounds + description: | + Please describe the possible workarounds you've implemented to work around the lacking functionality. + placeholder: Describe the possible workarounds here. + validations: + required: false + - type: input + id: jmeter-version + attributes: + label: JMeter Version + description: What JMeter version and edition did you use? + placeholder: ex. JMeter 5.5 + validations: + required: true + - type: input + id: java-version + attributes: + label: Java Version + description: What JDK version and distribution did you use (use `java -version`) + placeholder: ex. openjdk version "17" 2021-09-14 + - type: input + id: os-version + attributes: + label: OS Version + description: What operating system version and distribution did you use (use e.g. `ver` on Windows) + placeholder: ex. Microsoft Windows [Version 10.0.22000.856] diff --git a/.github/ISSUE_TEMPLATE/regression.yaml b/.github/ISSUE_TEMPLATE/regression.yaml new file mode 100644 index 00000000000..3bda8912d70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/regression.yaml @@ -0,0 +1,59 @@ +name: Regression +description: Report a problem about something that used to work +labels: + - regression + - to-triage +body: + - type: markdown + attributes: + value: | + Please fill in all required fields with as many details as possible. + Read the [User manual](https://jmeter.apache.org/usermanual/index.html) and/or [Reference documentation](https://jmeter.apache.org/usermanual/component_reference.html) + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + Describe what you were expecting JMeter to do + placeholder: | + Here you can also attach log files, screenshots or a video + - type: textarea + id: actual + attributes: + label: Actual behavior + description: | + Describe what you observed JMeter did instead + placeholder: | + Here you can also attach log files (e.g. jmeter.log), screenshots or a video + - type: textarea + id: steps + attributes: + label: Steps to reproduce the problem + description: | + - If the problem relates to a third-party plugin, consider removing them first + placeholder: | + Here you can also attach log files, screenshots or a video + validations: + required: true + - type: input + id: jmeter-version + attributes: + label: JMeter Version + description: | + What JMeter version and edition did you use? + Note: While you can obviously continue using older versions of JMeter, it may well be that your bug is already fixed. If you're using an older version, please also try to reproduce the bug in the latest version of JMeter before reporting it. + placeholder: ex. JMeter 5.5 + validations: + required: true + - type: input + id: java-version + attributes: + label: Java Version + description: What JDK version and distribution did you use (use `java -version`) + placeholder: ex. openjdk version "17" 2021-09-14 + - type: input + id: os-version + attributes: + label: OS Version + description: What operating system version and distribution did you use (use e.g. `ver` on Windows) + placeholder: ex. Microsoft Windows [Version 10.0.22000.856] diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index d24c0af1d5f..00000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,15 +0,0 @@ -# Reporting an issue: - -- Mention JVM implementation (OpenJDK, Oracle JDK, ...), versions of Java, Apache JMeter -- Provide anonymized and as simple as possible test plan helping reproduce the issue -- Provide jmeter.log -- If it's a bug, explain clearly how to reproduce: - - What should happen (OK Case) - - What happens (KO Case) -- If it's an enhancement request, explain what you want, why you need it and the clear use case -- Answer to questions of the person who handles your case - -Issue are related to bug or enhancements, it is not the right place to ask questions about usage, for the latter: - -- Read the [User manual](https://jmeter.apache.org/usermanual/index.html) and/or [Reference documentation](https://jmeter.apache.org/usermanual/component_reference.html) -- Ask questions on the [user mailing list](https://jmeter.apache.org/mail2.html). *Note you need to subscribe first*