Skip to content

Commit a1bbe97

Browse files
committed
Issue and PR templates
1 parent d036d78 commit a1bbe97

File tree

4 files changed

+134
-0
lines changed

4 files changed

+134
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: 'Bug report'
2+
description: 'Create a report to help us improve the project'
3+
labels: bug
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Describe the bug
9+
description: A clear and concise description of what the bug is
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: reproduction
14+
attributes:
15+
label: Reproduction
16+
description: Steps to reproduce the behavior
17+
placeholder: |
18+
1. Go to '...'
19+
2. Click on '...'
20+
3. Scroll down to '...'
21+
4. See error
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: platform
26+
attributes:
27+
label: Platform
28+
description: Please complete the following information
29+
placeholder: |
30+
- Device
31+
- Version
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: expected-behaviour
36+
attributes:
37+
label: Expected behavior
38+
description: A clear and concise description of what you expected to happen
39+
- type: textarea
40+
id: screenshots
41+
attributes:
42+
label: Screenshots
43+
description: If applicable, add screenshots to help explain your problem
44+
- type: textarea
45+
id: additional
46+
attributes:
47+
label: Additional context
48+
description: Add any other context about the problem here
49+
- type: checkboxes
50+
id: agreements
51+
attributes:
52+
label: Agreements
53+
description: By submitting this issue, you agree to follow our __Contributing Guidelines__ and __Code of Conduct__
54+
options:
55+
- label: I agree to follow this project's [__Code of Conduct__](https://github.com/GreenteaOS/.github/blob/kawaii/CODE_OF_CONDUCT.md)
56+
required: true

Diff for: .github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

Diff for: .github/ISSUE_TEMPLATE/feature_request.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 'Feature proposal'
2+
description: 'Suggest an idea for the NjRAA'
3+
labels: enhancement
4+
body:
5+
- type: textarea
6+
id: formulation
7+
attributes:
8+
label: Is your feature request related to some graphics API specifically? Please describe
9+
description: A clear and concise description of what the idea is
10+
placeholder: |
11+
I would like NjRAA to be capable of [...]
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Describe the solution you'd like
18+
description: A clear and concise description of what you want to happen
19+
- type: textarea
20+
id: alternatives
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+
- type: textarea
25+
id: possible-impacts
26+
attributes:
27+
label: Describe the possible impacts for the developers and users
28+
description: A clear and concise description of possible impacts
29+
- type: textarea
30+
id: additional
31+
attributes:
32+
label: Additional context
33+
description: Add any other context or screenshots about the feature request here
34+
- type: checkboxes
35+
id: agreements
36+
attributes:
37+
label: Agreements
38+
description: By submitting this issue, you agree to follow our __Contributing Guidelines__ and __Code of Conduct__
39+
options:
40+
- label: I agree to follow this project's [__Contributing Guidelines__](https://github.com/GreenteaOS/.github/blob/kawaii/CONTRIBUTING.md)
41+
required: true
42+
- label: I agree to follow this project's [__Code of Conduct__](https://github.com/GreenteaOS/.github/blob/kawaii/CODE_OF_CONDUCT.md)
43+
required: true

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Changes proposed in this pull request:
2+
3+
<!--
4+
Please insert below the list of changes in this pull request. For example:
5+
6+
- Change 1
7+
- Change 2
8+
- CHange 3
9+
-->
10+
11+
-
12+
13+
Related issue:
14+
15+
<!--
16+
If this pull request is related to any issue, then put its number here please. For example:
17+
18+
- #8
19+
-->
20+
21+
-
22+
23+
Checklist:
24+
25+
- [ ] My code is commented, has adequate variable/methods names, autoformatted or manually formatted
26+
- [ ] Code is __not copy-pasted__ from __leaked source codes__ of commercial projects, nor from projects protected with GPL-incompatible licenses
27+
- [ ] My pull request is complete and does not require any additional steps
28+
- [ ] `(optional)` I added my real name to the license sections of the modified source files, to improve protective power of the [GPL license](https://en.wikipedia.org/wiki/GNU_General_Public_License)
29+
- [ ] I have checked [automatic builds](https://github.com/GreenteaOS/NjRAA/actions) for this project and downloaded artifacts
30+
31+
Agreements
32+
33+
- [ ] I agree to follow this project's [__Contributing Guidelines__](https://github.com/GreenteaOS/.github/blob/kawaii/CONTRIBUTING.md)
34+
- [ ] I agree to follow this project's [__Code of Conduct__](https://github.com/GreenteaOS/.github/blob/kawaii/CODE_OF_CONDUCT.md)

0 commit comments

Comments
 (0)