From a65b6b0a50c64f2f9eb5c7d241a4de5a64194c73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8B=8F=E5=90=91=E5=A4=9C?= <46275354+fu050409@users.noreply.github.com> Date: Sat, 13 Jul 2024 10:22:46 -0400 Subject: [PATCH] chore(github): add issue template (#24) --- .github/ISSUE_TEMPLATE/bug_report.yml | 43 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++++++++++ 3 files changed, 82 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..c2ccdd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: "Bug Report" +description: Report a bug or issue with Grassator. +title: "[Bug Report]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + **Before You Start...** + + This form is only for submitting bug reports. If you have a usage question + or are unsure if this is really a bug, please use the [Discussions](https://github.com/noctisynth/Grassator/discussions) section instead. + + Also try to search for your issue - it may have already been answered or even fixed in the development branch. + However, if you find that an old, closed issue still persists in the latest version, + you should open a new issue using the form below instead of commenting on the old issue. + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: | + What do we need to do after opening your repro in order to make the bug happen? + Clear and concise reproduction instructions are important for us to be able to triage your issue in a timely manner. + Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code. + placeholder: | + Please provide a step-by-step guide to reproduce the issue. If possible, + provide screenshots or files like videos that show the issue. + validations: + required: true + - type: input + id: repro + attributes: + label: Reproduce link + description: "Please provide a simplest reproduction of the problem, provide the URL of the project:" + placeholder: Paste link here + - type: textarea + id: actually-happening + attributes: + label: What is actually happening? + placeholder: | + Describe what happened in detail. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..1a01e27 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: QQ Group + url: https://qm.qq.com/q/difHwaQXvi + about: Click to join the QQ group for discussion. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..71a0922 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: "Feature Request" +description: Submit a feature request or enhancement for Grassator +title: "[Feature Request]: " +labels: ["pending triage"] +body: + - type: markdown + attributes: + value: | + **Before You Start...** + + This form is only for submitting feature requests. If you have a usage question + or are unsure if this is really a bug, make sure to: + Also try to search for your issue - another user may have already requested something similar! + + - type: textarea + id: problem-description + attributes: + label: What problem does this feature solve? + description: | + Explain your use case, context, and rationale behind this feature request. More importantly, + what is the **end user experience** you are trying to build that led to the need for this feature? + placeholder: Problem description + validations: + required: true + - type: textarea + id: proposed-API + attributes: + label: What does the proposed API look like? + description: | + Describe how you propose to solve the problem and provide code samples of how the API would work once implemented. + Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format your code blocks. + placeholder: Proposed API + validations: + required: true