pre-commit check for files over 5MB

[JessicaS11]

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 66.19%. Comparing base (b0f4407) to head (03b0fcf).

Additional details and impacted files

@@             Coverage Diff              @@
##           development     #143   +/-   ##
============================================
  Coverage        66.19%   66.19%           
============================================
  Files               36       36           
  Lines             3065     3065           
  Branches           541      541           
============================================
  Hits              2029     2029           
  Misses             945      945           
  Partials            91       91           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[JessicaS11]

@lheagy Better late than never - I added some basic instructions on using pre-commit to the contribution guidelines. In general the documentation needs a bit of an overhaul/update, including more details on this, but I'd like to get the pre-commit hooks into the package in the meantime. I'm thinking a good path forward will be to provide these pre-commit hooks for those who want to use them, but ultimately add some more actions to PRs to do some of this checking and provide the code to run them manually if need be.

There shouldn't be any extra steps required for the large file hook (it stopped me from committing a too-large file), so I'm not sure what the issue might be. I did see some posts (e.g.) suggesting that there can be path issues if you've set core.hooksPath in your git config. That could cause it to skip the $GIT_DIR/hooks default, which is what is relied upon here.

[github-actions[bot]]

:point_left: Launch a binder notebook on this branch for commit e9e7f9caf6840e3d3a4fc79fb1fd18b4b8e90abc

I will automatically update this comment whenever this PR is modified

:point_left: Launch a binder notebook on this branch for commit 3a72f96f9c5cac5547dd451201ad8cb4776f4c85

:point_left: Launch a binder notebook on this branch for commit 15c0ce6489d6a19ed5c0a94a0ea2c244a43b315e

:point_left: Launch a binder notebook on this branch for commit 4366dd80aa83a24696688be8f685890a477a8e8b

:point_left: Launch a binder notebook on this branch for commit 3ce875ff1d87b980379d5ab6d1f6416f122d9e43

:point_left: Launch a binder notebook on this branch for commit 49d3a249967dc7f09df9fa2f89004f86d2eb5052

:point_left: Launch a binder notebook on this branch for commit c546ec169050773ef4c0cdb72c4d88dfdfd7e808

:point_left: Launch a binder notebook on this branch for commit 73bd5423925634c211c9c6c7153c5d9fd3ac5d07

:point_left: Launch a binder notebook on this branch for commit 03b0fcfe31fbe9d6ff5f60c31f708ccafe34103c

[JessicaS11]

@RomiP @zachghiaccio Are either of you able to give this a quick look? I'd like to make sure the explanatory text I added to the contributor docs makes sense.