Skip to content

Commit e421992

Browse files
committed
feat: add github issue templates
1 parent 8c3f86a commit e421992

File tree

4 files changed

+198
-0
lines changed

4 files changed

+198
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the information below.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Run command '...'
27+
2. See error '...'
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected Behavior
35+
description: What you expected to happen.
36+
placeholder: Describe what you expected...
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened.
45+
placeholder: Describe what actually happened...
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: tpa-version
51+
attributes:
52+
label: TPA Version
53+
description: "Run `tpa --version` to get the version"
54+
placeholder: "e.g., 0.1.6"
55+
validations:
56+
required: true
57+
58+
- type: input
59+
id: typescript-version
60+
attributes:
61+
label: TypeScript Version
62+
description: "Run `tsc --version` to get the version"
63+
placeholder: "e.g., 5.7.2"
64+
validations:
65+
required: true
66+
67+
- type: input
68+
id: node-version
69+
attributes:
70+
label: Node.js Version
71+
description: "Run `node --version` to get the version"
72+
placeholder: "e.g., 20.10.0"
73+
validations:
74+
required: true
75+
76+
- type: dropdown
77+
id: os
78+
attributes:
79+
label: Operating System
80+
options:
81+
- macOS
82+
- Windows
83+
- Linux
84+
- Other
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: trace-file
90+
attributes:
91+
label: Trace File Info (if applicable)
92+
description: If the issue is related to trace file parsing, provide details about the trace file (size, how it was generated, etc.)
93+
placeholder: |
94+
- File size:
95+
- Generated with: tsc --generateTrace
96+
- TypeScript project size:
97+
98+
- type: textarea
99+
id: additional
100+
attributes:
101+
label: Additional Context
102+
description: Add any other context, screenshots, or error logs here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/hg-pyun/typescript-performance-analyzer/discussions
5+
about: Ask questions and discuss with the community
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please describe your idea below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: "A clear description of what the problem is. Ex: I'm always frustrated when..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like.
25+
placeholder: A clear description of what you want to happen.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered.
34+
placeholder: Other approaches you've thought about...
35+
36+
- type: dropdown
37+
id: area
38+
attributes:
39+
label: Feature Area
40+
description: Which area of the tool does this feature relate to?
41+
options:
42+
- CLI Interface
43+
- Trace Analysis
44+
- HTML Report
45+
- Performance Metrics
46+
- Documentation
47+
- Other
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: additional
53+
attributes:
54+
label: Additional Context
55+
description: Add any other context, mockups, or examples about the feature request here.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Question
2+
description: Ask a question about usage or implementation
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Have a question? We're here to help!
10+
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: Your Question
15+
description: What would you like to know?
16+
placeholder: Describe your question in detail...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: context
22+
attributes:
23+
label: Context
24+
description: Provide any relevant context that might help us answer your question.
25+
placeholder: |
26+
- What are you trying to achieve?
27+
- What have you tried so far?
28+
- Any relevant configuration or code snippets?
29+
30+
- type: checkboxes
31+
id: checked-docs
32+
attributes:
33+
label: Documentation Check
34+
options:
35+
- label: I have checked the README and existing issues for an answer
36+
required: true

0 commit comments

Comments
 (0)