Skip to content

Commit 376ce31

Browse files
committed
Added GitHub templates for pull requests and issues.
1 parent 46d20b5 commit 376ce31

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
title: "[BUG] Description"
5+
labels: 'Issue: Bug'
6+
assignees: ''
7+
8+
---
9+
10+
#### Bug Report Checklist
11+
12+
- [ ] Have you provided a code sample to reproduce the issue?
13+
- [ ] Have you tested with the latest release to confirm the issue still exists?
14+
- [ ] Have you searched for related issues/PRs?
15+
- [ ] What's the actual output vs expected output?
16+
17+
<!--
18+
Please follow the issue template below for bug reports and feature requests.
19+
-->
20+
21+
**Description**
22+
A clear and concise description of what is the question, suggestion, or issue and why this is a problem for you.
23+
24+
**To Reproduce**
25+
Steps to reproduce the behavior.
26+
27+
**Expected behavior**
28+
A clear and concise description of what you expected to happen.
29+
30+
**Screenshots**
31+
If applicable, add screenshots to help explain your problem.
32+
33+
**Additional context**
34+
Add any other context about the problem here (OS, language version, etc..).
35+
36+
37+
**Related issues/PRs**
38+
Has a similar issue/PR been reported/opened before?
39+
40+
**Suggest a fix/enhancement**
41+
If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit), or simply make a suggestion.
42+
43+
*If this is a Feature request, please check out [this](feature_request.md).*
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[REQ] Feature Request Description"
5+
labels: 'Enhancement: Feature'
6+
assignees: ''
7+
8+
---
9+
10+
### Is your feature request related to a problem? Please describe.
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
### Describe the solution you'd like
15+
16+
A clear and concise description of what you want to happen.
17+
18+
### Describe alternatives you've considered
19+
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
### Additional context
23+
24+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- Please check the completed items below -->
2+
### PR checklist
3+
4+
- [ ] An issue/feature request has been created for this PR
5+
- [ ] Pull Request title clearly describes the work in the pull request and the Pull Request description provides details about how to validate the work. Missing information here may result in a delayed response.
6+
- [ ] File the PR against the `master` branch
7+
- [ ] The code in this PR is covered by unit tests
8+
9+
#### Link to issue/feature request: *add the link here*
10+
11+
#### Description
12+
A clear and concise description of what is this PR for and any additional info might be useful for reviewing it.

0 commit comments

Comments
 (0)