Skip to content

Commit

Permalink
chore(no-release): improve issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
TheEdoRan committed Jan 2, 2024
1 parent 24b313e commit 5cf946a
Show file tree
Hide file tree
Showing 6 changed files with 130 additions and 66 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug report
description: Create a report to help us fix bugs
title: "[BUG] <title>"
labels: ["bug"]
body:
- type: checkboxes
attributes:
label: Are you using the latest version of this library?
description: Please confirm that you are using the latest version of next-safe-action.
options:
- label: I verified that the issue exists in the latest next-safe-action release
required: true
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: I found out that the '...' functionality is not working.
validations:
required: true
- type: textarea
attributes:
label: Reproduction steps
description: Steps to reproduce the incorrect behavior.
placeholder: |
A step-by-step reproduction of the bug. For example:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A description of what you expected to happen instead.
placeholder: I expected that this happened instead.
validations:
required: true
- type: markdown
attributes:
value: Information about the environment you are using.
- type: input
attributes:
label: Operating System
placeholder: Windows 11, macOS, Ubuntu 22.04
validations:
required: true
- type: input
attributes:
label: Library version
placeholder: 6.0.0
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature request
description: Suggest an idea to improve this library
title: "[FEATURE] <title>"
labels: ["enhancement"]
body:
- type: checkboxes
attributes:
label: Are you using the latest version of this library?
description: Please confirm that you are using the latest version of next-safe-action.
options:
- label: I verified that the issue exists in the latest next-safe-action release
required: true
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Suggest an idea
description: Is your feature request related to a problem? Do you have a suggestion for improving this library? Please describe it here.
placeholder: I'd like to see ... implemented because...
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature request here.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/3_ask_a_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Ask a question
description: Need help with something? Let us know
title: "[ASK] <title>"
labels: ["question"]
body:
- type: checkboxes
attributes:
label: Are you using the latest version of this library?
description: Please confirm that you are using the latest version of next-safe-action.
options:
- label: I verified that the issue exists in the latest next-safe-action release
required: false
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Ask a question
description: Is your question related to an issue? Do you have any doubts about this library? Please describe it here.
placeholder: I don't understand how ... works
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about your question here.
validations:
required: false
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/ask-a-question.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

1 comment on commit 5cf946a

@vercel
Copy link

@vercel vercel bot commented on 5cf946a Jan 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.