Skip to content

Commit 0c6c8a9

Browse files
committed
feat(template): add issue and pull request template
1 parent 819b2eb commit 0c6c8a9

4 files changed

Lines changed: 81 additions & 0 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: "Bug Report"
2+
description: "Report a bug"
3+
title: "[Bug] "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: "Describe the bug"
10+
description: |
11+
A clear and concise description of what the bug is.
12+
If you have a screenshot of the bug, please attach it below.
13+
validations:
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: "Steps to reproduce the bug"
18+
description: "Tell us exactly how to reproduce the bug you are experiencing."
19+
placeholder: |
20+
1. ...
21+
2. ...
22+
3. ...
23+
validations:
24+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/theEvilReaper/Bounce/discussions
5+
about: If you have any questions or concerns (if you dont want to use Discord), please post them in our GitHub Discussions.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Feature request"
2+
description: "Suggest a new feature or enhancement"
3+
title: "Feature: "
4+
labels: [ "feature" ]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the feature
9+
description: |
10+
A clear and concise description of what the feature is.
11+
If you have a screenshot of the feature, please attach it below.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Why is this feature important to you?
17+
description: Tell us why you think this feature is important to you
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Additional context
23+
description: Add any other context or screenshots about the feature request here

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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.
4+
If it fixes a bug or resolves a feature request, be sure to link to that issue.
5+
6+
## Types of changes
7+
8+
What types of changes does your code introduce to this project?
9+
_Put an `x` in the boxes that apply_
10+
11+
- [ ] Bugfix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation Update (if none of the other choices apply)
15+
16+
## Checklist
17+
18+
_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
19+
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
20+
merging your code._
21+
22+
- [ ] I have read the CONTRIBUTING.md
23+
- [ ] I have added tests that prove my fix is effective or that my feature works
24+
- [ ] I have added necessary documentation (if appropriate)
25+
26+
## Further comments
27+
28+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you
29+
did and what alternatives you considered, etc...

0 commit comments

Comments
 (0)