mirror of
https://github.com/TheAlgorithms/Python.git
synced 2025-01-30 22:23:42 +00:00
Mandates referencing issue in PR (#1717)
* Mandates referencing issue in PR * Update CONTRIBUTING.md * Update pull_request_template.md * Update pull_request_template.md * Update pull_request_template.md * Update CONTRIBUTING.md Co-authored-by: John Law <johnlaw.po@gmail.com> Co-authored-by: Christian Clauss <cclauss@me.com>
This commit is contained in:
parent
63a1c4171a
commit
5c7d7782b0
1
.github/pull_request_template.md
vendored
1
.github/pull_request_template.md
vendored
|
@ -17,3 +17,4 @@
|
|||
* [ ] All function parameters and return values are annotated with Python [type hints](https://docs.python.org/3/library/typing.html).
|
||||
* [ ] All functions have [doctests](https://docs.python.org/3/library/doctest.html) that pass the automated testing.
|
||||
* [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
|
||||
* [ ] If this issues resolves an open issue then the commit message contains `Fixes: #{$ISSUE_NO}` for auto cleanup.
|
||||
|
|
|
@ -25,6 +25,8 @@ We appreciate any contribution, from fixing a grammar mistake in a comment to im
|
|||
|
||||
Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Python/pull_requests) to save time and mental energy. After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page. If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure. If you do not understand, please leave a comment on your submission page and a community member will try to help.
|
||||
|
||||
Please help us keep our issue list small by adding fixes: #{$ISSUE_NO} to the commit message of pull requests that resolve open issues. GitHub will use this tag to auto close the issue when the PR is merged.
|
||||
|
||||
#### Coding Style
|
||||
|
||||
We want your work to be readable by others; therefore, we encourage you to note the following:
|
||||
|
|
Loading…
Reference in New Issue
Block a user