-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add issue and pr templates (#73)
- Loading branch information
Showing
3 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: 'bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Describe the bug | ||
A clear and concise description of what the bug is. | ||
|
||
## How to Reproduce | ||
Steps to reproduce the behavior, as minimal as possible. | ||
|
||
## Expected behavior | ||
Description of what you expected to happen. | ||
|
||
## Actual behavior | ||
Description of what actually happens. If needed may contain logs/outputs. | ||
|
||
## Environment:** | ||
- OS: [e.g. OSX, Windows] | ||
- Python version [e.g. 3.7.11] | ||
|
||
## Additional context | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Is your feature request related to a problem? If so, please describe it. | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## How you envision the solution | ||
A clear and concise description of what you want to happen. | ||
|
||
## Describe alternatives you've considered | ||
A clear and concise description of any alternative solutions or features you have considered. | ||
|
||
## Additional context | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## Description | ||
|
||
Include description of feature this PR introduces or a bug that it fixes. Include the following information: | ||
|
||
- Context: why is it needed? In case of bug, what was the cause for the bug? | ||
- Concise description of the implemented solution. | ||
- If any dependencies are added, list them and justify why they are needed. | ||
|
||
## Please verify that you have completed the following steps | ||
|
||
- [ ] I have self-reviewed my code. | ||
- [ ] I have included test cases validating introduced feature/fix. | ||
- [ ] I have updated documentation. |