Skip to content

Commit

Permalink
chore: Update the issue templates (#682)
Browse files Browse the repository at this point in the history
  • Loading branch information
zoey-kaiser authored Feb 23, 2024
1 parent e36fbf6 commit 457cb50
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 30 deletions.
33 changes: 33 additions & 0 deletions .github/DISCUSSION_TEMPLATE/feature-requests.yml
Original file line number Diff line number Diff line change
@@ -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?
17 changes: 13 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature-request.yaml

This file was deleted.

37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!---
☝️ PR title should follow conventional commits (https://conventionalcommits.org)
Please carefully read the contribution docs before creating a pull request
👉 https://nuxt.com/docs/community/contribution
-->

### 🔗 Linked issue

<!-- Please ensure there is an open issue and mention its number as #123 -->

### ❓ Type of change

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->

- [ ] 📖 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

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have linked an issue or discussion.
- [ ] I have added tests (if possible).
- [ ] I have updated the documentation accordingly.

0 comments on commit 457cb50

Please sign in to comment.