Skip to content

Commit 8e7253a

Browse files
authored
add a pull request template (#355)
* add .github/PULL_REQUEST_TEMPLATE.md * update whatsnew, minor edit template * friendly pr template * add description request, delete request
1 parent 95fe1f6 commit 8e7253a

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
pvlib python pull request guidelines
2+
====================================
3+
4+
Thank you for your contribution to pvlib python!
5+
6+
You may submit a pull request with your code at any stage of completion, however, before the code can be merged the following items must be addressed:
7+
8+
- [ ] Closes issue #xxxx
9+
- [ ] Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests must pass on the TravisCI and Appveyor testing services.
10+
- [ ] Code quality and style is sufficient. Passes ``git diff upstream/master -u -- "*.py" | flake8 --diff`` and/or landscape.io linting service.
11+
- [ ] New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
12+
- [ ] Updates entries to `docs/sphinx/source/api.rst` for API changes.
13+
- [ ] Adds description and name entries in the appropriate `docs/sphinx/source/whatsnew` file for all changes.
14+
15+
Please don't hesitate to ask for help if you're unsure of how to accomplish any of the above. You may delete all of these instructions except for the list above.
16+
17+
Brief description of the problem and proposed solution (if not already fully described in the issue linked to above):

docs/sphinx/source/whatsnew/v0.5.0.rst

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Documentation
3535
~~~~~~~~~~~~~
3636
* Added ModelChain documentation page
3737
* Added nbsphinx to documentation build configuration.
38+
* Added a pull request template file (:issue:`354`)
3839

3940
Testing
4041
~~~~~~~

0 commit comments

Comments
 (0)