Skip to content

Commit 6ee160b

Browse files
committed
friendly pr template
1 parent 2351075 commit 6ee160b

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
- [ ] Closes #xxxx
2-
- [ ] Tests added / passed
3-
- [ ] Passes ``git diff upstream/master -- pvlib | flake8 --diff``
4-
- [ ] Fully documented, including the appropriate `docs/sphinx/source/whatsnew` file for all changes and the `docs/sphinx/source/api.rst` for new API
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.

0 commit comments

Comments
 (0)