Skip to content
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

Updated Pull Request Template. #24

Merged
merged 2 commits into from
Dec 31, 2024
Merged

Updated Pull Request Template. #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd062fe
no commented code, no print statements
colevandersWands Dec 31, 2024
5effaf5
do not call the function in the function file
colevandersWands Dec 31, 2024
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
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ about: A template PR for code review with a checklist
- [ ] The function's name describes it's behavior
- [ ] The function's name matches the file name
- [ ] The function has correct type annotations
- [ ] The function is not called in the function file

## Strategy

Expand Down Expand Up @@ -82,5 +83,7 @@ about: A template PR for code review with a checklist
- [ ] Variable names are clear and helpful
- [ ] The code follows the strategy as simply as possible
- [ ] The implementation is as simple as possible given the strategy
- [ ] There are no commented lines of code
- [ ] There are no `print` statements anywhere
- [ ] The code includes defensive assertions
- [ ] Defensive assertions include as little logic as possible
Loading