-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from znicholls/pr-template
Add PR template and CHANGELOG
- Loading branch information
Showing
4 changed files
with
76 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,31 @@ | ||
--- | ||
name: Bug Report | ||
about: Write a report to help us improve | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**Failing Test** | ||
|
||
Please put the code (ideally in the form of a unit | ||
test) which fails below | ||
|
||
**Expected behavior** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
**System (please complete the following information):** | ||
|
||
- OS: [e.g. Windows, Linux, macOS] | ||
- Python version [e.g. Python 3.5] and output of `conda list --export` and `pip freeze` as applicable | ||
|
||
**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,21 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
|
||
A clear and concise description of what the problem is. Ex. It's annoying that I always have to [...] | ||
|
||
**Describe the solution you'd like** | ||
|
||
A clear and concise description of the solution you would like to see. | ||
|
||
**Describe alternatives you've considered** | ||
|
||
A clear and concise description of any alternative solutions or features you've 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,17 @@ | ||
# Pull request | ||
|
||
Please confirm that this pull request has done the following: | ||
|
||
- [ ] Tests added | ||
- [ ] Documentation added (where applicable) | ||
- [ ] Example added (either to an existing notebook or as a new notebook, where applicable) | ||
- [ ] Description in ``CHANGELOG.rst`` added | ||
|
||
## Adding to CHANGELOG.rst | ||
|
||
Please add a single line in the changelog notes similar to one of the following: | ||
|
||
``` | ||
- (`#XX <https://github.com/znicholls/silicone/pull/XX>`_) Added feature which does something | ||
- (`#XX <https://github.com/znicholls/silicone/pull/XX>`_) Fixed bug identified in (`#YY <https://github.com/znicholls/silicone/issues/YY>`_) | ||
``` |
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,7 @@ | ||
Changelog | ||
========= | ||
|
||
master | ||
------ | ||
|
||
- (`#1 <https://github.com/znicholls/silicone/pull/1>`_) Added pull request and issues templates |