Skip to content

Commit f1a8f84

Browse files
webdevcodywebdevcody
authored
Merge pull request #43 from Psypher1/pr-template
#26 | Added pull request and issue templates
2 parents 61843ae + d9bb90c commit f1a8f84

File tree

4 files changed

+213
-0
lines changed

4 files changed

+213
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Bug Report
2+
description: Create a bug report to help us improve
3+
title: "[BUG]: "
4+
labels:
5+
- "bug"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Try to describe what happened...
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduce
21+
attributes:
22+
label: Reproduction Steps
23+
description: How do you trigger this bug? Please walk us through it step by step.
24+
placeholder: |
25+
1. Go to '...'
26+
2. Click on '...'
27+
3. Scroll down to '...'
28+
...
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected Behaviour
35+
description: What did you expect to happen, or should happen ideally.
36+
placeholder: What should normally happen when steps are taken
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: actual
41+
attributes:
42+
label: Actual Behaviour
43+
description: What actually happened.
44+
placeholder: What actually happened when steps were taken instead of what should happen?
45+
validations:
46+
required: true
47+
- type: dropdown
48+
id: os
49+
attributes:
50+
label: Operating System / Platform
51+
description: What operating system were you running?
52+
options:
53+
- Windows
54+
- Mac (iOS)
55+
- Linux / Unix
56+
- Android
57+
- iPhone (iOS)
58+
validations:
59+
required: true
60+
- type: dropdown
61+
id: browsers
62+
attributes:
63+
label: (optional) What browsers are you seeing the problem on?
64+
multiple: true
65+
options:
66+
- Firefox
67+
- Chrome
68+
- Safari
69+
- Microsoft Edge
70+
- type: textarea
71+
id: logs
72+
attributes:
73+
label: Relevant log output
74+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
75+
render: bash
76+
- type: checkboxes
77+
id: terms
78+
attributes:
79+
label: Code of Conduct
80+
# description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
81+
description: By submitting this issue, you agree to follow our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
82+
options:
83+
- label: I agree to follow this project's Code of Conduct
84+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature Request
2+
description: Request a new feature for this project
3+
title: "[FEATURE]: "
4+
labels:
5+
- "feature"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to submit this feature request!
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Feature Summary
15+
description: A clear and concise description of the feature.
16+
placeholder: "Example: As a [user role], I want to [complete action] so that I can [achieve outcome]"
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: acceptance
21+
attributes:
22+
label: Acceptance criteria
23+
description: What would you consider to be completion for this feature?
24+
placeholder: |
25+
- [ ] [User Role] can [Action] [Resource]
26+
- [ ] [User Role] can also [Action] [Resource]
27+
- [ ] [Other User Role] cannot [Action] [Resource]
28+
...
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: scenario
33+
attributes:
34+
label: Scenario
35+
description: Describe a scenario where this feature would be useful.
36+
placeholder: Under what circumstances would this feature be useful
37+
- type: textarea
38+
id: context
39+
attributes:
40+
label: Any Additional Context
41+
description: Any other context or additional information.
42+
placeholder: Any other context or additional information you wish to share about the proposed feature...
43+
- type: checkboxes
44+
id: terms
45+
attributes:
46+
label: Code of Conduct
47+
description: By submitting this issue, you agree to follow our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
48+
options:
49+
- label: I agree to follow this project's Code of Conduct
50+
required: true

‎.github/ISSUE_TEMPLATE/task.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Task
2+
description: Request a new task for this project
3+
title: "[TASK]: "
4+
labels:
5+
- "task"
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to submit this task request form!
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Task Summary
15+
description: A brief description of what the task will accomplish.
16+
placeholder: "Example: Make [x] do [y]"
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: acceptance
21+
attributes:
22+
label: Acceptance criteria
23+
description: What would you consider to be completion for this task?
24+
placeholder: |
25+
- [ ] [x] does/is [y] or [x] exists
26+
...
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: context
31+
attributes:
32+
label: Any Additional Context
33+
description: Any other context or additional information.
34+
placeholder: Any other context or additional information you wish to share about the proposed feature...

‎.github/pull_request_template.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Issue # |
3+
---
4+
5+
<!-- Please enusure your PR title follows the pattern:
6+
[Issue ID] | Short description of the changes made
7+
-->
8+
9+
## What type of PR is this? (select all that apply)
10+
11+
- [ ] 🍕 Feature
12+
- [ ] 🐛 Bug Fix
13+
- [ ] 🚧 Breaking Change
14+
- [ ] 🧑‍💻 Code Refactor
15+
- [ ] 📝 Documentation Update
16+
17+
## Description
18+
19+
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
20+
21+
## Related Tickets & Documents
22+
23+
- Related Issue #
24+
- Closes #
25+
26+
## QA Instructions, Screenshots, Recordings
27+
28+
<!-- Please replace this line with instructions on how to test your changes, a note
29+
on the devices and browsers this has been tested on, as well as any relevant
30+
images for UI changes. -->
31+
32+
### UI accessibility concerns?
33+
34+
<!-- If your PR includes UI changes, please replace this line with details on how
35+
accessibility is impacted and tested. -->
36+
37+
## Added/updated tests?
38+
39+
- [ ] 👍 yes
40+
- [ ] 🙅 no, because they aren't needed
41+
- [ ] 🙋 no, because I need help
42+
43+
## [optional] Are there any post deployment tasks we need to perform?
44+
45+
## [optional] What gif best describes this PR or how it makes you feel?

0 commit comments

Comments
 (0)