Skip to content

Commit df09689

Browse files
committed
docs: update github issues templates
1 parent 1b04627 commit df09689

4 files changed

Lines changed: 130 additions & 72 deletions

File tree

.github/ISSUE_TEMPLATE/01_bug-report.md

Lines changed: 0 additions & 35 deletions
This file was deleted.
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: "\U0001F41B Bug report"
2+
description: Create a report to help us improve
3+
title: "[BUG] Title"
4+
labels: [":bug: bug"]
5+
assignees: ["Romakita"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
---
13+
> **IMPORTANT: Before opening issue**
14+
>
15+
> - Please update all of your packages. I won't investigate on the issue if you are on an old version.
16+
> - Please check that you have the same version for all Ts.ED dependencies (expected the logger). Many issues are related to a misconfigured packages.
17+
> - Please provide a reproducible example (avoid screenshot, prefer copy/pasted code). The stack trace isn't enough to investigate.
18+
>
19+
> If these requirements aren't checked, I WON'T INVESTIGATE (excepted if you are a premium sponsors!) and issue will be closed!
20+
---
21+
22+
- type: textarea
23+
id: what-happened
24+
attributes:
25+
label: Describe the bug
26+
description: A clear and concise description of what the bug is.
27+
placeholder: Tell us what you see!
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: repro-steps
32+
attributes:
33+
label: To Reproduce
34+
description: Steps to reproduce the behavior
35+
placeholder: |
36+
1. Fetch a '...'
37+
2. Update the '....'
38+
3. See error
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: expected-behavior
43+
attributes:
44+
label: Expected behavior
45+
description: A clear and concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: code-snippets
50+
attributes:
51+
label: Code snippets
52+
description: If applicable, add code snippets to help explain your problem.
53+
render: TypeScript
54+
validations:
55+
required: false
56+
- type: input
57+
id: repositoryUrl
58+
attributes:
59+
label: Repository URL example
60+
placeholder: https://github.com/your/repository
61+
- type: input
62+
id: os
63+
attributes:
64+
label: OS
65+
placeholder: macOS
66+
validations:
67+
required: true
68+
- type: input
69+
id: language-version
70+
attributes:
71+
label: Node version
72+
placeholder: Node v18.17.1
73+
validations:
74+
required: true
75+
- type: input
76+
id: lib-version
77+
attributes:
78+
label: Library version
79+
placeholder: v7.34.7
80+
validations:
81+
required: true
82+
- type: textarea
83+
id: additional-context
84+
attributes:
85+
label: Additional context
86+
description: Add any other context about the problem here.
87+
validations:
88+
required: false

.github/ISSUE_TEMPLATE/02_feature-request.md

Lines changed: 0 additions & 37 deletions
This file was deleted.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: "\U0001F680 Feature request"
2+
description: Suggest an idea for this library
3+
labels: [":sparkles: enhancement"]
4+
assignees: ["Romakita"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request!
10+
11+
---
12+
> - All request features / PR are welcome!
13+
> - The Ts.ED team will works on the requested feature if:
14+
> - The community vote massively for it.
15+
> - The you are a premium sponsors (individual or company sponsors).
16+
---
17+
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: Is your feature request related to a problem? Please describe.
22+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Describe the solution you'd like
27+
description: A clear and concise description of what you want to happen.
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Describe alternatives you've considered
32+
description: A clear and concise description of any alternative solutions or features you've considered.
33+
# - type: textarea
34+
# id: context
35+
# attributes:
36+
# label: Additional context
37+
# description: Add any other context about the feature request here.
38+
# - type: textarea
39+
# id: context
40+
# attributes:
41+
# label: Acceptance criteria
42+
# description: Add acceptance criteria here.

0 commit comments

Comments
 (0)