[WIP] Add pre-commit config and installation notes #22
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.
This adds a
pre-commit
config file to the repo, so that contributors can run those hooks locally automatically when committing.The configs are lifted from the cryoet-data-portal repo.
I chose
pre-commit
(over something more JS likehusky
) because I have some familiarity with it and because it's plausible we might have some other languages in this repo (e.g. Python for generating synthetic data, converting real data, or hosting local files).Here's some console output when making a change with broken formatting