From 466299b43fc8d19587c2a9f35b1813424d686fd2 Mon Sep 17 00:00:00 2001 From: Serhii Korchynskyi Date: Thu, 6 Jul 2023 10:48:55 +0200 Subject: [PATCH] Add ISSUE_TEMPLATE (#89) --- .github/ISSUE_TEMPLATE/bug-report.yml | 83 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 45 ++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 17 +++++ 3 files changed, 145 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..41ff5189 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,83 @@ +name: 🐞 Bug Report +description: Provide a general summary of the bug in the title below. +title: "[Bug]: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + **Thank you :heart: for taking the time to fill out this bug report!** + - type: dropdown + id: severity + validations: + required: true + attributes: + label: Severity + description: How severe is the bug in your opinion? + multiple: false + options: + - "Trivial" + - "Medium" + - "High" + - "Critical" + - "Blocker" + - type: input + id: version + validations: + required: true + attributes: + label: What release version, tag or commit-hash did you use? + description: Please include a link if possible. + placeholder: v0.1.0 or 06f432a00e4c66804202c91bdfb9c9b12823928b + - type: textarea + id: current-behavior + validations: + required: true + attributes: + label: Current Behavior + description: Tell us what happened instead of the expected behavior. + placeholder: Error message appeared when I cloned a repository... + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: Steps to Reproduce + description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant + placeholder: | + 1. ... + 2. ... + 3. ... + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: Expected Behavior + description: Tell us what should happen + placeholder: Clone of repository shall be prune of errors. + - type: textarea + id: possible-solution + validations: + required: false + attributes: + label: Possible Solution + description: Fix/reason of the bug suggestion + placeholder: A possible solution or fix is... + - type: textarea + id: additional-information + validations: + required: false + attributes: + label: Additional Information + description: Provide an additional detailed description / screenshots / evidences of the bug + placeholder: I would like to add... + - type: checkboxes + id: code-of-conduct + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our "Code of Conduct". + options: + - label: I agree to follow this project's "Code of Conduct". + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..3fb9bbb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,45 @@ +name: 🛠️ Feature Request +description: Suggest an idea to help us improve our product. +title: "[Feature]: " +labels: + - "enhancement" +body: + - type: markdown + attributes: + value: | + **Thank you :heart: for taking the time to fill out this feature request report!** + We kindly ask you to search if an issue already exists for your requested feature. + + We are happy about contributions from all users. + - type: textarea + attributes: + label: Description + description: | + A clear and concise description of the feature you're interested in. + validations: + required: true + + - type: textarea + attributes: + label: Suggested Solution + description: | + Describe the solution you'd like to be implemented. Provide a clear and concise description of what you want to happen. + validations: + required: false + + - type: textarea + attributes: + label: Alternatives + description: | + Describe alternatives you've considered. + A clear and concise description of alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + attributes: + label: Additional Context + description: | + Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..a15e4539 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,17 @@ +name: ❓ Question or general issue +description: Approach us with a question +title: "[Q]: " +labels: + - question +body: + - type: markdown + attributes: + value: | + **We are happy that you have a question to ask!** + - type: textarea + validations: + required: true + attributes: + label: Question + description: Feel free to ask us if you need assistance + placeholder: How can I create a repository based on your template?