From c1b120f0bf00224581d5a40366e91694b92cf0a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Wed, 6 Nov 2024 10:24:22 +0100 Subject: [PATCH] chore: add issue templates (#173) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- .github/ISSUE_TEMPLATE/bug.yaml | 68 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 52 +++++++++++++++ .github/ISSUE_TEMPLATE/general-question.yaml | 36 +++++++++++ 3 files changed, 156 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/general-question.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..721b450 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,68 @@ +# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json + +name: Bug Report +description: Report a bug +title: '[Bug] ' +labels: +- bug +- triage +body: + - type: markdown + attributes: + value: Please tell us about the bug. + - type: dropdown + id: version + attributes: + label: Version + description: What version are you running? + options: + - v0.0.1 + validations: + required: true + - type: textarea + id: bug-description + attributes: + label: Description + description: Describe what happened. + validations: + required: true + - type: textarea + id: bug-reproduce-steps + attributes: + label: Steps to reproduce + description: What are the exact steps needed to reproduce the bug you experienced? + value: |- + 1. + validations: + required: true + - type: textarea + id: bug-expectations + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: bug-screenshots + attributes: + label: Screenshots + description: >- + If you have any screenshots that would help, please paste them below. + GitHub allows you to copy-and-paste directly from the clipboard into the text area. + **Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below. + validations: + required: false + - type: textarea + id: logs + attributes: + label: Logs + description: Please copy and paste any relevant log output. + render: Shell + - type: checkboxes + id: troubleshooting + attributes: + label: Troubleshooting + description: By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem. + options: + - label: I have searched other issues in this repository and mine is not recorded. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 0000000..4a7668f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,52 @@ +# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json + +name: Feature Request +description: Suggest a new feature +title: '[Feature] ' +labels: +- enhancement +- triage +body: + - type: markdown + attributes: + value: Please explain the new feature. + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Describe the problem. + placeholder: A clear and concise description of the problem statement. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Solution Description + description: Describe the solution you'd like. + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Describe alternatives you've considered. + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Context + description: Any additional context to this enhancement request. + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: false + - type: checkboxes + id: research + attributes: + label: Research + description: By submitting this issue, you agree that you have performed some basic attempts at researching your problem and solution. + options: + - label: I have searched other issues in this repository and mine is not recorded. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/general-question.yaml b/.github/ISSUE_TEMPLATE/general-question.yaml new file mode 100644 index 0000000..8242c42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general-question.yaml @@ -0,0 +1,36 @@ +# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json + +name: General Question +description: Ask a question or need support +title: '[Question] ' +labels: +- question +body: + - type: markdown + attributes: + value: Please answer these questions before submitting your issue. Thanks! + - type: textarea + id: describe-your-question + attributes: + label: Describe your question + description: Provide details about your question or the support needed. + placeholder: Type your question here... + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version are you running? + options: + - v0.0.1 + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the question here. + placeholder: Additional details... + validations: + required: false