Update PR template #7794
Merged
Update PR template #7794
Conversation
This file contains hidden or 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
algorithms-keeper
bot
added
documentation
CaedenPH
reviewed
Oct 28, 2022
.github/pull_request_template.md
Outdated
| * [ ] All functions and variable names follow Python naming conventions. | ||
| * [ ] 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. | ||
| * [ ] All new algorithms have a URL in their comments that point to Wikipedia or another similar explanation. |
There was a problem hiding this comment.
Perhaps this
Suggested change
| * [ ] All new algorithms have a URL in their comments that point to Wikipedia or another similar explanation. | |
| * [ ] All new algorithms have a docstring containing a URL that point to Wikipedia or another similar explanation. |
or
Suggested change
| * [ ] All new algorithms have a URL in their comments that point to Wikipedia or another similar explanation. | |
| * [ ] All new algorithms include at least one URL that points to Wikipedia or another similar explanation. |
These make a bit more sense in my opinion
cclauss
reviewed
Oct 28, 2022
.github/pull_request_template.md
Outdated
| @@ -11,10 +11,8 @@ | |||
| * [ ] This pull request is all my own work -- I have not plagiarized. | |||
| * [ ] I know that pull requests will not be merged if they fail the automated tests. | |||
| * [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms. | |||
| * [ ] All new Python files are placed inside an existing directory. | |||
| * [ ] All filenames are in all lowercase characters with no spaces or dashes. | |||
There was a problem hiding this comment.
Sorry but I like both of these. I know that continuous integration will catch these after the first commit but most first-time contributors (the majority of our contributors) cannot figure out how to change the filepath in GitHub UI so they are forced close the pr and then immediately open a duplicate. I would rather warn them of these rules before the make these mistakes.
The other modification look right to me.
cclauss
approved these changes
Oct 28, 2022
algorithms-keeper
bot
removed
the
awaiting reviews
|
Thanks for doing this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your change:
I know that pull requests will not be merged if they fail the automated tests.. Although this is good to have one more reminder I find this huge list a bit overwhelming.Checklist:
Fixes: #{$ISSUE_NO}.