Skip to content

Commit 211ecea

Browse files
authored
chore: add GitHub templates (#64)
* chore: add PR template * chore: add feature request template
1 parent 9a02f4b commit 211ecea

File tree

2 files changed

+71
-0
lines changed

2 files changed

+71
-0
lines changed

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "Component/Hook Request"
2+
description: "Add suggestion for a component and/or a hook"
3+
labels: ["feature"]
4+
body:
5+
- type: "markdown"
6+
attributes:
7+
value: |
8+
Thanks for creating an issue!
9+
10+
Make sure to search open/closed issues before submitting.
11+
- type: "textarea"
12+
id: "description"
13+
attributes:
14+
label: "Description"
15+
description: "Please describe your idea in one or two sentences."
16+
validations:
17+
required: true
18+
- type: "textarea"
19+
id: "justification"
20+
attributes:
21+
label: "Why is this needed?"
22+
description: |
23+
Please explain why you believe this is needed.
24+
validations:
25+
required: true
26+
- type: "textarea"
27+
id: "proposed-solution"
28+
attributes:
29+
label: "Proposed Solution or API"
30+
description: |
31+
Please share what you believe the ideal design/API should be like.
32+
You can use code snippets, gists, or links to communicate it.
33+
validations:
34+
required: true
35+
- type: "textarea"
36+
id: "additional-information"
37+
attributes:
38+
label: "Additional Information"
39+
description: |
40+
What resources (links, screenshots, etc.) do you have to assist this
41+
effort?

.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!---
2+
Thanks for creating a Pull Request!
3+
4+
Please read the following before submitting:
5+
- Keep your PR as small as possible.
6+
- Limit your PR to one type (docs, feature, refactoring, ci, or bugfix)
7+
- Reference the issue you're modifying.
8+
-->
9+
10+
Closes # <!-- Github issue # here -->
11+
12+
## Description
13+
14+
> Add a brief description
15+
16+
## 📝 Additional Information
17+
18+
> Anything else you'd want reviewers to know.
19+
<!--- Remember:
20+
You have a lot more context than whoever is going to review.
21+
The more details you provide, the easier you make for others
22+
to review the PRs.
23+
-->
24+
25+
<!---
26+
## Screenshot
27+
28+
If your changes are visual, please add a screenshot.
29+
If they're behavioral, consider adding a screen recording of the change.
30+
-->

0 commit comments

Comments
 (0)