From 21a51b935cd843647ad62924e16f7063cfea22ee Mon Sep 17 00:00:00 2001 From: chansee97 Date: Tue, 23 Apr 2024 11:22:24 +0800 Subject: [PATCH] feat: add issue template --- .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug-report.yml | 42 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yml | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/others.yml | 31 +++++++++++++++ 5 files changed, 120 insertions(+) create mode 100644 .github/FUNDING.yml 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 create mode 100644 .github/ISSUE_TEMPLATE/others.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..9fdd9389 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +custom: ['https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-wechat.png', 'https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-alipay.png'] diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..4e43c94e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,42 @@ +name: 🐞 Bug report +description: Create a report to help us improve +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Description + description: Please explain clearly how the bug reappears. If possible, it is best to add the cause of the problem. + placeholder: bug description + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected + validations: + required: true + + - type: textarea + id: additional-comments + attributes: + label: Additional comments + description: e.g. some background/context of how you ran into this bug. + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Ensure this issue not a bug proposal. + required: true + - label: Read the [docs](https://nova-admin-docs.netlify.app/). + required: true + - label: Check that there isn't [already an issue](https://github.com/chansee97/nova-admin/issues) that descript the same thing to avoid creating a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3ba13e0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..fe5870d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,45 @@ +name: ✨ New feature + +description: Propose a new feature to be added to Nova-admin + +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to fill out this feature report! + + - type: textarea + id: feature-description + attributes: + label: Description + description: Clear and concise description of the problem. Please make the reason and usecases as detailed as possible. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: As a developer using Nova-admin I want [goal / wish] so that [benefit]... + validations: + required: true + + - type: textarea + id: suggested-solution + attributes: + label: Suggestion + description: In module [xy] we could provide following implementation... + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Any other context or screenshots about the feature request here. + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Ensure this issue not a feature proposal. + required: true + - label: Read the [docs](https://nova-admin-docs.netlify.app/). + required: true + - label: Check that there isn't [already an issue](https://github.com/chansee97/nova-admin/issues) that descript the same thing to avoid creating a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/others.yml b/.github/ISSUE_TEMPLATE/others.yml new file mode 100644 index 00000000..4da50fab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/others.yml @@ -0,0 +1,31 @@ +name: 👓 Others + +description: Create an issue for Nova-admin + +body: + - type: markdown + attributes: + value: | + Thanks for your interest in the project and taking the time to create this issue! + + - type: textarea + id: description + attributes: + label: Description + description: Clear and concise description of the issue. Thanks! + placeholder: There are some thing I want to ... + validations: + required: true + + - type: checkboxes + id: checkboxes + attributes: + label: Validations + description: Before submitting the issue, please make sure you do the following + options: + - label: Ensure this issue neither a bug report nor a feature proposal. + required: true + - label: Read the [docs](https://nova-admin-docs.netlify.app/). + required: true + - label: Check that there isn't [already an issue](https://github.com/chansee97/nova-admin/issues) that descript the same thing to avoid creating a duplicate. + required: true