Skip to content

Update PR template #7794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2022
Merged

Update PR template #7794

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4ce044
Update PR template
Cjkjvfnby Oct 27, 2022
6b37049
Revert changes, reword line
Cjkjvfnby Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

* [ ] 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

* [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.