From 457cb5094d22eb8794faf1e122aa33646f489344 Mon Sep 17 00:00:00 2001 From: Zoey Date: Fri, 23 Feb 2024 20:37:29 +0100 Subject: [PATCH] chore: Update the issue templates (#682) --- .../DISCUSSION_TEMPLATE/feature-requests.yml | 33 +++++++++++++++++ .github/ISSUE_TEMPLATE/bug-report.yaml | 17 +++++++-- .github/ISSUE_TEMPLATE/config.yml | 8 ++-- .github/ISSUE_TEMPLATE/feature-request.yaml | 22 ----------- .github/PULL_REQUEST_TEMPLATE.md | 37 +++++++++++++++++++ 5 files changed, 87 insertions(+), 30 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/feature-requests.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/DISCUSSION_TEMPLATE/feature-requests.yml b/.github/DISCUSSION_TEMPLATE/feature-requests.yml new file mode 100644 index 00000000..9d31ded7 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/feature-requests.yml @@ -0,0 +1,33 @@ +name: "๐Ÿš€ Feature request" +description: Suggest a feature that will improve NuxtAuth +labels: ["pending", "enchantment"] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to NuxtAuth, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: provider + attributes: + label: Which provider would this enchantment improve? + description: We currently offer three providers: authjs, local and refresh. If the enchanment is a general one, please select all three. + options: + - label: AuthJS + - label: Local + - label: Refresh + - label: New Provider + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 0236ebf8..56a70070 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,23 +1,32 @@ name: ๐Ÿž Bug report description: Create a bug report for this project -labels: [bug] +labels: [bug, pending] body: - type: markdown attributes: value: | - Please help us finding and resolving problems. + Please carefully read the nuxt contribution docs before creating a bug report + ๐Ÿ‘‰ https://nuxt.com/docs/community/reporting-bugs + + Please use a template below to create a minimal reproduction + ๐Ÿ‘‰ https://stackblitz.com/github/nuxt/starter/tree/v3 + ๐Ÿ‘‰ https://codesandbox.io/s/github/nuxt/starter/tree/v3 - type: textarea id: bug-env attributes: label: Environment description: You can use `npx nuxi info` to fill this section placeholder: Environment + validations: + required: true - type: textarea id: reproduction attributes: label: Reproduction - description: Provide a link to a repo that can reproduce the problem you ran into if you can. + description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it. placeholder: Reproduction + validations: + required: true - type: textarea id: bug-description attributes: @@ -37,4 +46,4 @@ body: label: Logs description: | Optional if provided reproduction. Please try not to insert an image but copy paste the log text. - render: shell + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7f137cd5..3daa74ee 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: ๐Ÿ“š nuxt-auth documentation url: https://sidebase.io/nuxt-auth about: Check the documentation for usage of nuxt-auth - - name: ๐Ÿ’ฌ Discussions - url: https://github.com/sidebase/nuxt-auth/discussions - about: Use discussions if you have another issue, an idea for improvement or for asking questions. + - name: ๐Ÿš€ Feature request + url: https://github.com/sidebase/nuxt-auth/discussions/new?category=feature-requests + about: Suggest a feature to improve this project diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml deleted file mode 100644 index 6e196c0e..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ /dev/null @@ -1,22 +0,0 @@ -name: ๐Ÿš€ Feature request -description: Suggest a feature to improve this project -labels: [enhancement] -body: - - type: markdown - attributes: - value: | - Thank you for taking the time to fill out this feature request of this young, just growing project. It really means a lot to us! โค๏ธ - - type: textarea - id: feature-description - attributes: - label: Describe the feature - description: A clear and concise description of what you think would be a helpful addition, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. - placeholder: Feature description - validations: - required: true - - type: textarea - id: additional-info - attributes: - label: Additional information - description: Additional information that helps us decide how to proceed. - placeholder: Additional information diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..f99be3b8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ + + +### ๐Ÿ”— Linked issue + + + +### โ“ Type of change + + + +- [ ] ๐Ÿ“– Documentation (updates to the documentation, readme or JSdoc annotations) +- [ ] ๐Ÿž Bug fix (a non-breaking change that fixes an issue) +- [ ] ๐Ÿ‘Œ Enhancement (improving an existing functionality like performance) +- [ ] โœจ New feature (a non-breaking change that adds functionality) +- [ ] ๐Ÿงน Chore (updates to the build process or auxiliary tools and libraries) +- [ ] โš ๏ธ Breaking change (fix or feature that would cause existing functionality to change) + +### ๐Ÿ“š Description + + + + + +### ๐Ÿ“ Checklist + + + + + +- [ ] I have linked an issue or discussion. +- [ ] I have added tests (if possible). +- [ ] I have updated the documentation accordingly.