Skip to content

Commit 6dd0a6d

Browse files
committed
Add GitHub issue and PR templates with standardized formats
1 parent 8ee9958 commit 6dd0a6d

File tree

5 files changed

+153
-0
lines changed

5 files changed

+153
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Issue Type
2+
<!-- Please mark with an x in the appropriate brackets -->
3+
- [ ] Bug Report
4+
- [ ] Feature Request
5+
- [ ] Documentation Improvement
6+
- [ ] Other
7+
8+
## Description
9+
<!-- Please provide a clear description of the issue -->
10+
11+
## Steps to Reproduce
12+
<!-- For bugs, please list the steps to reproduce the issue -->
13+
1.
14+
2.
15+
3.
16+
17+
## Expected Behavior
18+
<!-- Describe what you expected to happen -->
19+
20+
## Additional Information
21+
<!-- Add any other context about the issue here -->

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: Report a bug to help us improve
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug
16+
placeholder: Tell us what happened
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps-to-reproduce
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '....'
28+
3. Scroll down to '....'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected-behavior
35+
attributes:
36+
label: Expected Behavior
37+
description: A clear and concise description of what you expected to happen
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: environment
43+
attributes:
44+
label: Environment
45+
description: Information about your environment
46+
placeholder: |
47+
- OS: [e.g. macOS, Windows]
48+
- Node version: [e.g. 18.16.0]
49+
validations:
50+
required: false
51+
52+
- type: textarea
53+
id: additional-context
54+
attributes:
55+
label: Additional Context
56+
description: Add any other context about the problem here
57+
validations:
58+
required: false
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature!
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Description
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: 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: I would like to see...
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+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: additional-context
39+
attributes:
40+
label: Additional Context
41+
description: Add any other context or screenshots about the feature request here
42+
validations:
43+
required: false

.github/ISSUE_TEMPLATE/other.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Other Issue
2+
description: Report an issue that doesn't fit into other categories
3+
title: "[Other]: "
4+
labels: ["other"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report this issue!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the issue
16+
placeholder: Describe your issue here...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: additional-context
22+
attributes:
23+
label: Additional Context
24+
description: Add any other context about the issue here
25+
validations:
26+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Changes
2+
<!-- Briefly describe the changes made in this PR -->
3+
4+
5+

0 commit comments

Comments
 (0)