Skip to content

Commit

Permalink
chore: improve issue template
Browse files Browse the repository at this point in the history
Closes #446
  • Loading branch information
Diizzayy committed Nov 9, 2022
1 parent 1f52586 commit 7e99825
Show file tree
Hide file tree
Showing 4 changed files with 89 additions and 7 deletions.
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: "\U0001F41B Bug report"
description: "Something isn't working"

labels: ["bug"]

body:
- type: textarea
id: environment
validations:
required: true
attributes:
label: Environment
description: You can use `npx nuxi info` to fill this section
placeholder: Environment

- type: textarea
id: bug-description
validations:
required: true
attributes:
label: Describe the bug
description: "What isn't working? Describe the bug you've encountered."
placeholder: Bug description

- type: textarea
id: expected-behaviour
validations:
required: true
attributes:
label: Expected behaviour
description: "What did you expect to happen? Is there a section in the docs about this?"

- type: textarea
id: reproduction
validations:
required: false
attributes:
label: Reproduction
description: "Please provide a link to a repo that can reproduce the problem you ran into. 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."
placeholder: Reproduction

- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context about the problem here.

- type: textarea
id: logs
attributes:
label: Logs
description: Optional if a reproduction is provided. Please try not to insert an image but copy paste the log text.
render: shell
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
contact_links:
- name: 📚 Documentation
about: Check documentation for usage
url: https://apollo.nuxtjs.org

- name: 💬 Discussions
url: https://github.com/nuxt-modules/apollo/discussions
about: Use discussions if you have an idea for improvement and asking questions
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feat-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "🚀 Feature request"
description: Suggest a feature
labels: ["enhancement"]
body:
- type: textarea
validations:
required: true
attributes:
label: Your use case
description: Add a description of your use case, and how this feature would help you.
placeholder: When I do [...] I would expect to be able to do [...]

- type: textarea
validations:
required: true
attributes:
label: "The solution you'd like"
description: "Describe what you want to happen."

- type: textarea
attributes:
label: "Possible alternatives"
description: "Have you considered any alternative solutions?"

- type: textarea
attributes:
label: Additional information
description: Is there any other context you think would be helpful to know?

0 comments on commit 7e99825

Please sign in to comment.