Skip to content

Commit 3e9ce5c

Browse files
authored
feat: add pr and issue templates (#54)
1 parent f92f305 commit 3e9ce5c

File tree

12 files changed

+109
-27
lines changed

12 files changed

+109
-27
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: 🐛 Bug
2+
description: Report an issue to help improve the project.
3+
labels: ["🛠 goal: fix"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A brief description of the question or issue, also include what you tried and what didn't work
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: screenshots
14+
attributes:
15+
label: Screenshots
16+
description: Please add screenshots if applicable
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: extrainfo
21+
attributes:
22+
label: Additional information
23+
description: Is there anything else we should know about this bug?
24+
validations:
25+
required: false
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 💡 General Feature Request
2+
description: Have a new idea/feature? Please suggest!
3+
title: "[FEATURE] <description>"
4+
labels: ["⭐ goal: addition"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: A brief description of the enhancement you propose, also include what you tried and what worked.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: screenshots
15+
attributes:
16+
label: Screenshots
17+
description: Please add screenshots if applicable
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: extrainfo
22+
attributes:
23+
label: Additional information
24+
description: Is there anything else we should know about this idea?
25+
validations:
26+
required: false

.github/ISSUE_TEMPLATE/other.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Other
2+
description: Use this for any other issues. Please do NOT create blank issues
3+
title: "[OTHER]"
4+
labels: ["🚦 status: awaiting triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "# Other issue"
9+
- type: textarea
10+
id: issuedescription
11+
attributes:
12+
label: What would you like to share?
13+
description: Provide a clear and concise explanation of your issue.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: extrainfo
18+
attributes:
19+
label: Additional information
20+
description: Is there anything else we should know about this issue?
21+
validations:
22+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- If your PR fixes an open issue, use `Closes #999` to link your PR with the issue. #999 stands for the issue number you are fixing -->
2+
3+
## Fixes Issue
4+
5+
<!-- Remove this section if not applicable -->
6+
7+
<!-- Example: Closes #31 -->
8+
9+
## Changes proposed
10+
11+
<!-- List all the proposed changes in your PR -->
12+
13+
<!-- Mark all the applicable boxes. To mark the box as done follow the following conventions -->
14+
<!--
15+
[x] - Correct; marked as done
16+
[X] - Correct; marked as done
17+
18+
[ ] - Not correct; marked as **not** done
19+
-->
20+
21+
## Check List (Check all the applicable boxes) <!-- Follow the above conventions to check the box -->
22+
23+
- [ ] My code follows the code style of this project.
24+
- [ ] My change requires changes to the documentation.
25+
- [ ] I have updated the documentation accordingly.
26+
- [ ] All new and existing tests passed.
27+
- [ ] This PR does not contain plagiarized content.
28+
- [ ] The title of my pull request is a short description of the requested changes.
29+
30+
## Screenshots
31+
32+
<!-- Add all the screenshots which support your changes -->
33+
34+
## Note to reviewers
35+
36+
<!-- Add notes to reviewers if applicable -->

CHANGELOG.md

100644100755
File mode changed.

CODE_OF_CONDUCT.md

100644100755
File mode changed.

LICENSE

100644100755
File mode changed.

README.md

100644100755
File mode changed.

commitlint.config.js

100644100755
File mode changed.

package.json

100644100755
File mode changed.

0 commit comments

Comments
 (0)