Skip to content

Commit 67fac5c

Browse files
authored
Merge pull request #15 from QrystaL/github-templates
Added issue/PR templates
2 parents d2ba360 + 2a2866d commit 67fac5c

File tree

3 files changed

+108
-0
lines changed

3 files changed

+108
-0
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
title: "[Bug]: "
4+
body:
5+
- type: textarea
6+
id: what-happened
7+
attributes:
8+
label: Describe the bug
9+
description: A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: repro-steps
14+
attributes:
15+
label: To Reproduce
16+
description: Steps to reproduce the behavior
17+
value: |
18+
1. Go to '...'
19+
2. Click on '...'
20+
3. Scroll down to '...'
21+
4. See error
22+
render: shell
23+
- type: textarea
24+
id: expected-behavior
25+
attributes:
26+
label: Expected behavior
27+
description: A clear and concise description of what you expected to happen.
28+
render: shell
29+
- type: textarea
30+
id: desktop-info
31+
attributes:
32+
label: Desktop
33+
value: |
34+
- OS: [e.g. Windows 11]
35+
- Browser: [e.g. Chrome, Edge]
36+
- Version: [e.g. 122]
37+
render: shell
38+
- type: textarea
39+
id: smartphone-info
40+
attributes:
41+
label: Smartphone
42+
value: |
43+
- Device: [e.g. iPhone 15]
44+
- OS: [e.g. iOS 17.4]
45+
- Browser: [e.g. Stock browser, Safari]
46+
- Version: [e.g. 122]
47+
render: shell
48+
- type: textarea
49+
id: additional-ctx
50+
attributes:
51+
label: Additional context
52+
description: Add any other context about the problem here.
53+
render: shell
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
body:
5+
- type: textarea
6+
id: feature-info
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: A clear and concise description of what the problem is. Add any screenshots about the feature request here.
10+
value: "I'm always frustrated when [...]"
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: expected-solution
15+
attributes:
16+
label: Describe the solution you'd like
17+
description: A clear and concise description of what you want to happen.
18+
render: shell
19+
- type: textarea
20+
id: alternatives-info
21+
attributes:
22+
label: Describe alternatives you've considered
23+
description: A clear and concise description of any alternative solutions or features you've considered.
24+
render: shell
25+
- type: textarea
26+
id: additional-ctx
27+
attributes:
28+
label: Additional context
29+
description: Add any other context about the feature request here.
30+
render: shell

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Proposed Changes
2+
3+
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
4+
5+
## Types of changes
6+
7+
What types of changes does your code introduce?
8+
_Put an `x` in the boxes that apply_
9+
10+
- [ ] Bugfix (non-breaking change which fixes an issue)
11+
- [ ] New feature (non-breaking change which adds functionality)
12+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
14+
15+
## Checklist
16+
17+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
18+
19+
- [ ] Build and tests pass locally
20+
- [ ] I have added tests that prove my fix is effective or that my feature works (if appropriate)
21+
- [ ] I have added necessary documentation (if appropriate)
22+
23+
## Further comments
24+
25+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

0 commit comments

Comments
 (0)