From 6c1cff8abb8041dfa95689591f79824d04cf1268 Mon Sep 17 00:00:00 2001 From: utarwyn Date: Sun, 26 May 2024 19:01:44 +0200 Subject: [PATCH] Update GitHub issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 60 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 39 -------------- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 26 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- .github/ISSUE_TEMPLATE/question.md | 10 ---- 6 files changed, 91 insertions(+), 69 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..4681a1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,60 @@ +name: 🐞 Bug Report +description: This form is to report unexpected behavior in ecoCode-javascript. +labels: [ "💉 bug: unconfirmed" ] +body: + - type: markdown + attributes: + value: | + Thank you for taking your precious time to file an issue! 🙏 We are sorry for the inconvenience this issue has caused you and want to resolve it as soon as possible. + + Help us help you! We know that your time is precious and hate to ask for any more of it, but the first step in fixing this issue is to understand the issue. Taking some extra time to ensure that we are able to reproduce the issue will help us significantly in resolving the issue. + - type: textarea + id: current-behavior + attributes: + label: Current Behavior + description: What is the behavior that currently you experience? + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What is the behavior that you expect to happen? + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Please provide some instructions to reproduce the issue. Be as detailed as possible. + value: | + 1. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Failure Logs + description: Please include any relevant log snippets or files here. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: input + id: plugin-version + attributes: + label: ecoCode-javascript Version + description: Please provide the version of ecoCode-javascript that you are using. + validations: + required: true + - type: input + id: sonarqube-version + attributes: + label: SonarQube Version + description: Please provide the version of SonarQube that you are using if this is applicable. + - type: textarea + id: additional + attributes: + label: Additional Information + description: Is there any additional information that you can provide? + - type: markdown + attributes: + value: | + > If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce. Please do your best to fill out all of the sections above. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c72a322..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Report a way in which ecoCode-javascript is not working as intended -title: '' -labels: '💉 bug: unconfirmed' -assignees: '' - ---- - -### Describe the bug - -A clear and concise description of what the bug is. - -### To Reproduce - -Steps to reproduce the behavior: - -1. ... -2. ... - -### Expected behavior - -A clear and concise description of what you expected to happen. - -### Versions - -> Please ensure you are running up to date software before making a bug report. Deprecated versions will not receive -> support. - -- ecoCode-javascript version: -- SonarQube version (if applicable): - -### Screenshots - -If applicable, add screenshots to help explain your problem. - -### Additional context - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..1a1c3f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Start a Discussion + about: "Start a discussion to share your experience with ecoCode-javascript" + url: https://github.com/green-code-initiative/ecoCode-javascript/discussions/new/choose diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..a8588f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,26 @@ +name: ✨ Feature Request +description: This form is to request a new feature in ecoCode-javascript. +labels: [ "🚀 enhancement" ] +body: + - type: textarea + id: solution + attributes: + label: Solution you'd like + description: Please write a clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: problem-related + attributes: + label: Is your feature request related to a problem? + description: Please write a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + - type: textarea + id: alternatives + attributes: + label: Alternatives you've considered + description: Please include a clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional + attributes: + label: Additional Information + description: Is there any additional information or screenshots that you want to provide? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index fa20b46..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for ecoCode-javascript -title: '' -labels: '🚀 enhancement' -assignees: '' - ---- - -### Is your feature request related to a problem? Please describe. - -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -### Describe the solution you'd like - -A clear and concise description of what you want to happen. - -### Additional context - -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 65b9167..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Question -about: You need information about something on the plugin -title: '' -labels: '❔ question' -assignees: '' - ---- - -Ask your question in this textfield. Please be as precise as possible. Duplicate questions will not be answered.