Skip to content

Commit 372a674

Browse files
committed
chore: add pr and issue templates
1 parent 282da18 commit 372a674

5 files changed

Lines changed: 117 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Bug Report
2+
description: Report a reproducible bug or unexpected behavior
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: Describe the bug, including expected and actual behavior
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: steps
15+
attributes:
16+
label: Steps to Reproduce
17+
description: Provide a list of steps to reproduce the bug
18+
placeholder: |
19+
1. Run `yarn dev`
20+
2. Enter `...`
21+
3. See error
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: environment
27+
attributes:
28+
label: Environment
29+
description: Provide relevant environment details (OS, runtime, etc).
30+
placeholder: "`node -v && uname -a` e.g., Ubuntu 25.04, Node 22.16.0"
31+
validations:
32+
required: false
33+
34+
- type: textarea
35+
id: logs
36+
attributes:
37+
label: Logs or Screenshots
38+
description: Include relevant logs, stack traces, or screenshots
39+
validations:
40+
required: false
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Docs Update
2+
description: Suggest an update or improvement to the documentation
3+
labels: ["documentation"]
4+
body:
5+
- type: textarea
6+
id: suggestion
7+
attributes:
8+
label: Suggested Update
9+
description: Describe the proposed documentation update or fix
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: context
15+
attributes:
16+
label: Additional Context
17+
description: Add any other relevant information or context
18+
validations:
19+
required: false
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Suggest an idea or enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: summary
7+
attributes:
8+
label: Feature Summary
9+
description: Clearly describe the feature you’d like to see added
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: usecase
15+
attributes:
16+
label: Use Case
17+
description: Explain why this feature is useful or what problem it solves
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives Considered
25+
description: Have you considered other solutions or workarounds?
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
id: additional
31+
attributes:
32+
label: Additional Context
33+
description: Add any other context or screenshots here
34+
validations:
35+
required: false

.github/ISSUE_TEMPLATE/generic.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Generic Issue
2+
description: Open a general issue or question
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Description
8+
description: Provide a detailed description of the issue or question
9+
validations:
10+
required: true

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Issue
2+
3+
Closes #<issue-number>
4+
5+
## Checklist
6+
7+
Please ensure the following items are completed before requesting review:
8+
9+
* [ ] Updated `CHANGELOG.md` with relevant changes
10+
* [ ] Documented the contribution in `README.md`
11+
* [ ] Added tests to demonstrate correct behavior (both positive and negative cases)
12+
* [ ] All tests pass successfully (`npm test`)
13+
* [ ] Code passes linting checks (`npm run lint`)

0 commit comments

Comments
 (0)