Add .github folder. Add ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md.

This commit is contained in:
Davide Casale
2023-03-06 19:09:32 +01:00
parent a4c1418113
commit 08af0c8c90
2 changed files with 65 additions and 0 deletions

35
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,35 @@
## I'm submitting a...
- [ ] bug report;
- [ ] feature request;
- [ ] documentation change;
## What is the expected behaviour?
<!--- Describe the expected behaviour in details -->
## What is the current behaviour?
<!--- Describe the current behaviour in details -->
## Possible solution (optional)
<!-- If you have a solution proposal, please explain it here -->
<!-- If your solution includes implementation, you should also open a PR with this as related issue -->
<!-- You can delete this section if you don't want to suggest a possible solution -->
A possible solution could be...
## Steps to reproduce (for bugs)
<!-- You can delete this section if you are not submitting a bug report -->
1. &nbsp;
2. &nbsp;
3. &nbsp;
### Python version
<!-- Indicate your python version here -->
<!-- You can print it using `python3 --version`-->
Python 3.10.6 x64
### Mypy version
<!-- Indicate your mypy version here -->
<!-- You can print it using `python3 -m mypy --version`-->
mypy 0.991 (compiled: yes)

30
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,30 @@
# Description
<!--- Describe your changes in detail -->
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
## Related Issue
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->
PR fixes the following issue:
## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue);
- [ ] New feature (non-breaking change which adds functionality);
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected);
- [ ] This change requires a documentation update;
# Checklist:
- [ ] My code follows the style guidelines of this project;
- [ ] I have performed a self-review of my code;
- [ ] I have commented my code, particularly in hard-to-understand areas;
- [ ] I have made corresponding changes to the documentation;
- [ ] My changes generate no new warnings;
- [ ] I have added tests that prove my fix is effective or that my feature works;
- [ ] New and existing unit tests pass locally with my changes;
- [ ] Mypy does not return any errors or warnings if runned on the root package;
- [ ] I have updated the library version and updated the CHANGELOG;