Skip to content

Commit 7efc8c0

Browse files
committed
added github issue templates
1 parent 4dfc765 commit 7efc8c0

File tree

3 files changed

+118
-0
lines changed

3 files changed

+118
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: 🐞 Bug Report
2+
description: Something does not work or is flaky! let us know!
3+
labels: ['TYPE: bug', 'STATUS-1: needs triage']
4+
title: '[🐞]'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: dropdown
12+
id: package
13+
attributes:
14+
label: Which package is affected?
15+
options:
16+
- Headless Kit
17+
- Styled Kit
18+
- Utils
19+
- CLI
20+
- Documentation Website
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: description
26+
attributes:
27+
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!'
28+
label: Describe the bug
29+
placeholder: I am doing ... What I expect is ... What actually happening is ...
30+
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: reproduction
36+
attributes:
37+
label: Reproduction
38+
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 14 days, it will be auto-closed.
39+
placeholder: Reproduction URL
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reproduction-steps
45+
attributes:
46+
label: Steps to reproduce
47+
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.
48+
placeholder: Run `npm install` followed by `npm run dev`
49+
50+
- type: textarea
51+
id: system-info
52+
attributes:
53+
label: System Info
54+
description: Output of `npx envinfo --system --npmPackages '{vite,undici,typescript,@builder.io/*,@qwik-ui/*}' --binaries --browsers`
55+
render: shell
56+
placeholder: System, Binaries, Browsers
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: additional_information
62+
attributes:
63+
label: Additional Information
64+
validations:
65+
required: false
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 📖 Documentation Suggestion
2+
description: Suggestions on how we can improve the documentation.
3+
title: '[📖]'
4+
labels: ['PKG: docs', 'STATUS-1: needs triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
description: 'A clear and concise description of your suggestion to improve the docs.'
15+
label: Suggestion
16+
validations:
17+
required: true

.github/ISSUE_TEMPLATE/feature.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: ✨ Feature Request
2+
description: Suggest an idea for this project.
3+
labels: ['TYPE: enhancement', 'STATUS-1: needs triage']
4+
title: '[✨]'
5+
body:
6+
- type: textarea
7+
id: use_case
8+
attributes:
9+
label: 'Is your feature request related to a problem?'
10+
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: "Describe the solution you'd like"
18+
description: 'A clear and concise description of what you want to happen.'
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: "Describe alternatives you've considered"
26+
description: "A clear and concise description of any alternative solutions or features you've considered."
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: additional_context
32+
attributes:
33+
label: 'Additional context'
34+
description: 'Add any other context or screenshots about the feature request here.'
35+
validations:
36+
required: false

0 commit comments

Comments
 (0)