Skip to content

Commit 8c974d8

Browse files
committed
Adds github issue/PR templates
1 parent 929208c commit 8c974d8

File tree

4 files changed

+108
-0
lines changed

4 files changed

+108
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Description
2+
3+
Please insert a description of your problem or question.
4+
5+
## Error messages, screenshots
6+
7+
Please add any error logs or screenshots if available.
8+
9+
## Failing test, failing GitHub repo, or reproduction steps
10+
11+
Please add either a failing test, a GitHub repo of the problem or detailed reproduction steps.
12+
13+
## Expected Behavior
14+
15+
Please define what you would expect the behavior to be like.
16+
17+
## Known workarounds
18+
19+
Please provide a description of any known workarounds.
20+
21+
## Other information
22+
23+
* Operating System:
24+
- [ ] windows [insert version here]
25+
- [ ] macOs [insert version]
26+
- [ ] linux [insert flavor/version here]
27+
* Platform
28+
- [ ] dotnet core
29+
- [ ] dotnet full
30+
- [ ] mono
31+
* Branch or release version:

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Desktop (please complete the following information):**
24+
- OS: [e.g. iOS]
25+
- Browser [e.g. chrome, safari]
26+
- Version [e.g. 22]
27+
28+
**Smartphone (please complete the following information):**
29+
- Device: [e.g. iPhone6]
30+
- OS: [e.g. iOS8.1]
31+
- Browser [e.g. stock browser, safari]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.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 to MyLib.1?
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)