.gitignore updated with many data file types to exclude from commits
pre-commit yaml updated so it excludes any files with the same extensions (e.g. excel, csv....)
pre-commit has been added to requirements.txt
You will need to install new requirements from requirements.txt
No data files are needed but you might want to create a couple of dummy files, like "dummy.csv" or "dummy.feather" to see if you can commit them.
Closes or fixes
Closes #326
Code
[x] Requirements My/our code matches the requirements of the ticket
[ ] Functionality: New functions meet requirements in issue ticket N/A
[X] Compliant Code Code is as PEP 8 compliant as I can humanly make it
[X] Code runs The code runs on my machine
[ ] Clean Code N/A
[ ] Code has been linted (use your favourite linter) N/A
Any new code includes all the following forms of documentation:
[ ] Function Documentation Docstrings within the function(s') definition(s) have been created N/A
[ ] Includes parameters and returns for all major functions N/A
[ ] Includes data types N/A
[ ] Updated Documentation: Working doc has been updated and a new ticket to update the master documentation has been created.
I HAVE CREATED A TICKET, but don't have access to the Google doc to update it
Data
[ ] All data needed to run this script has been added to Sync N/A
Testing
[ ] Unit tests Unit tests have been created and are passing or a new ticket to create tests has been created N/A
Peer Review Section
[x] All requirements install from (updated) requirements.txt
[ ] Documentation has been created and is clear - check the google Doc
[x] Doctrings (Google format) have been created and accurately describe the function's functionality
[x] Unit tests pass, or if not present a new ticket to create tests has been created
[x] Code runs The code runs on reviewer's machine
Final approval (post-review)
The author has responded to my review and made changes to my satisfaction.
[ ] I recommend merging this request.
Review comments
Insert detailed comments here!
These might include, but not exclusively:
bugs that need fixing (does it work as expected? and does it work with other code
that it is likely to interact with?)
alternative methods (could it be written more efficiently or with more clarity?)
documentation improvements (does the documentation reflect how the code actually works?)
additional tests that should be implemented (do the tests effectively assure that it
works correctly?)
code style improvements (could the code be written more clearly?)
Your suggestions should be tailored to the code that you are reviewing.
Be critical and clear, but not mean. Ask questions and set actions.
Pull Request submission
You will need to install new requirements from
requirements.txt
No data files are needed but you might want to create a couple of dummy files, like "dummy.csv" or "dummy.feather" to see if you can commit them.Closes or fixes
Closes #326
Code
Documentation
Any new code includes all the following forms of documentation:
parameters
andreturns
for all major functions N/AData
Testing
Peer Review Section
requirements.txt
Final approval (post-review)
The author has responded to my review and made changes to my satisfaction.
Review comments
Insert detailed comments here!
These might include, but not exclusively:
Your suggestions should be tailored to the code that you are reviewing. Be critical and clear, but not mean. Ask questions and set actions.