Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve bug report template #2236

Merged
merged 1 commit into from
Nov 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 31 additions & 26 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -1,28 +1,12 @@
name: 🐞 Bug Report
description: Something does not work or is flaky! let us know!
labels: [bug, triage]
title: '[🐞]'
body:
- type: input
id: version
attributes:
label: Qwik Version
placeholder: e.g. vX.Y.Z
validations:
required: true

- type: input
id: os_version
attributes:
label: Operating System (or Browser)
validations:
required: true

- type: input
id: node_version
- type: markdown
attributes:
label: Node Version (if applicable)
validations:
required: false
value: |
Thanks for taking the time to fill out this bug report!

- type: dropdown
id: component
Expand All @@ -33,23 +17,44 @@ body:
- Qwik Rollup / Vite plugin
- Qwik Optimizer (rust)
- Qwik React
- Qwik City
- Qwik City (routing)
- Starters / CLI
validations:
required: true

- type: textarea
id: expected_behaviour
id: description
attributes:
description: 'A clear and concise description of what you expected to happen.'
label: Expected Behaviour
description: 'A clear and concise description of what you expected to happen instead. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
label: Describe the bug
placeholder: I am doing ... What I expect is ... What actually happening is ...

validations:
required: true

- type: input
id: reproduction
attributes:
label: Reproduction
description: Please provide a link via [qwik.new](https://qwik.new/) or a link to a repo that can reproduce the problem you ran into. `npm create qwik@latest` can be used as a starter template. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). 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 after 3 days, it will be auto-closed.
placeholder: Reproduction URL
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce
description: Please provide any reproduction steps that may need to be described. E.g. if it happens only when running the dev or build script make sure it's clear which one to use.
placeholder: Run `npm install` followed by `npm run dev`

- type: textarea
id: actual_behaviour
id: system-info
attributes:
label: Actual Behaviour
label: System Info
description: Output of `npx envinfo --system --npmPackages '{vite,@builder.io/*}' --binaries --browsers`
render: shell
placeholder: System, Binaries, Browsers
validations:
required: true

Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: 🤔 Support Question
url: https://qwik.builder.io/chat
about: This issue tracker is not for support questions. Please post your question on the Discord chat.
9 changes: 0 additions & 9 deletions .github/ISSUE_TEMPLATE/docs_suggestion.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: 📖 Documentation Suggestion
description: Suggestions on how we can improve the documentation.
title: '[📖]'
labels: [documentation]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out docs suggestion! However, if you think it's something you can fix yourself, please submit a PR instead.
In every doc page, you will be able to find the "Edit this page" in the right menu!
![Screenshot](https://user-images.githubusercontent.com/127379/203278116-7986d8b2-6aad-45fd-9890-7f171ca26bf0.png)

- type: textarea
id: description
attributes:
description: 'A clear and concise description of your suggestion to improve the docs.'
label: Suggestion
validations:
required: true
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: ✨ Feature Request
description: Suggest an idea for this project.
labels: [enhancement, triage]
title: '[✨]'
body:
- type: textarea
id: use_case
Expand All @@ -19,7 +20,7 @@ body:
required: true

- type: textarea
id: alterntives
id: alternatives
attributes:
label: "Describe alternatives you've considered"
description: "A clear and concise description of any alternative solutions or features you've considered."
Expand Down