From 0f9573ed1298b2a9d755a8191acd771a321e63c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bla=C5=BE=20Dular?= <22869613+xBlaz3kx@users.noreply.github.com> Date: Sat, 18 Jan 2025 21:04:33 +0100 Subject: [PATCH] Added issue templates (#72) --- .github/ISSUE_TEMPLATE/bug.yml | 60 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 45 ++++++++++++++++ .github/ISSUE_TEMPLATE/general_question.yml | 20 +++++++ 3 files changed, 125 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/general_question.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..057b6e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,60 @@ +name: '🐛 Bug Report' +description: 'Submit a bug report' +title: '🐛 Bug: ' +labels: [ 'type: bug' ] +body: + - type: textarea + id: description + validations: + required: true + attributes: + label: '📜 Description' + description: 'A clear and concise description of what the bug is.' + placeholder: 'It bugs out when ...' + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: '👟 Reproduction steps' + description: 'How do you trigger this bug? Please walk us through it step by step.' + placeholder: "1. Install the package\n2. Run the command ..." + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: '👍 Expected behavior' + description: 'What did you think should happen?' + placeholder: 'It should ...' + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: '👎 Actual Behavior' + description: 'What did actually happen? Add screenshots, if applicable.' + placeholder: 'It actually ...' + - type: input + id: release-version + validations: + required: false + attributes: + label: release version + description: Mention the release version of the software you are using. + placeholder: v1.2.3 + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: '📃 Provide any additional context for the Bug.' + description: 'Add any other context about the problem here.' + placeholder: 'It actually ...' + - type: checkboxes + id: no-duplicate-issues + attributes: + label: '👀 Have you spent some time to check if this bug has been found before?' + options: + - label: "I checked and didn't find a similar issue" + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..5de4427 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,45 @@ +name: 🚀 Feature +description: 'Submit a proposal for a new feature' +title: '🚀 Feature: ' +labels: [ feature ] +body: + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: '🔖 Feature description' + description: 'A clear and concise description of what the feature is.' + placeholder: 'You should add ...' + - type: textarea + id: pitch + validations: + required: true + attributes: + label: '🎤 Why is this feature needed ?' + description: 'Please explain why this feature should be implemented and how it would be used. Add examples, if + applicable.' + placeholder: 'In my use-case, ...' + - type: textarea + id: solution + validations: + required: true + attributes: + label: '✌️ How do you aim to achieve this?' + description: 'A clear and concise description of what you want to happen.' + placeholder: 'I want this feature to, ...' + - type: textarea + id: alternative + validations: + required: false + attributes: + label: '🔄️ Additional Information' + description: "A clear and concise description of any alternative solutions or additional solutions you've considered." + placeholder: 'I tried, ...' + - type: checkboxes + id: no-duplicate-issues + attributes: + label: '👀 Have you spent some time to check if this feature request has been raised before?' + options: + - label: "I checked and didn't find similar issue" + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general_question.yml b/.github/ISSUE_TEMPLATE/general_question.yml new file mode 100644 index 0000000..5747eba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_question.yml @@ -0,0 +1,20 @@ +name: '❔ Question' +description: 'Submit a general question to the community.' +title: '❔ Question: ' +labels: [ 'type: question' ] +body: + - type: textarea + id: description + validations: + required: true + attributes: + label: '❔ What is your question?' + description: 'The stage is yours. Ask away! Try to provide as much context as possible.' + placeholder: 'What is the best way to ...' + - type: checkboxes + id: no-duplicate-issues + attributes: + label: '👀 Have you spent some time to check if this question has been asked before?' + options: + - label: "I checked and didn't find a similar issue" + required: true \ No newline at end of file