Skip to content

Commit 9bc4fef

Browse files
Introduce a PR template to the repo (#58)
1 parent 2bc8c11 commit 9bc4fef

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Pull Request Summary
2+
3+
## Description
4+
5+
_Please include a summary of the changes. Please also include the relevant context and motivation. List any dependencies and assumptions that are required for this change._
6+
7+
8+
## How did you test your code?
9+
10+
_Which of the following have you done to test your changes? Please describe the tests that you ran to verify your changes._
11+
- [ ] Created new unit tests in `tests/` for the newly implemented methods
12+
- [ ] Updated existing unit tests in `tests/` to cover changes made to existing methods
13+
14+
15+
## Checklist
16+
17+
_Please make sure all items in this checklist have been fulfilled before sending your PR out for review!_
18+
19+
- [ ] I have commented my code in details, particularly in hard-to-understand areas
20+
- [ ] I have updated [Readme.rst](https://github.com/scaleapi/scaleapi-python-client/blob/master/README.rst) document with examples for newly implemented public methods
21+
- [ ] I have reviewed [Deployment and Publishing Guide for Python SDK](https://github.com/scaleapi/scaleapi-python-client/blob/master/docs/pypi_update_guide.md) document
22+
- [ ] I incremented the SDK version in `_version.py` _(unless this PR only updates the documentation)._
23+
- [ ] In order to release a new version, a "Release Summary" needs to be prepared and published after the merge

0 commit comments

Comments
 (0)