Ergonomic pre commit proposal #259
Draft
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.
Context
This pull request enhances the CI process for the templates repository. Currently, we use pre-commit hooks to check for code consistency and automatically generate README.md from Jupyter notebooks.
Problems
pre-commitaren't staged automatically. As a result, you need to re-stage the changes again, which isn't intuitive for contributors who are used to a single git commit motion.Changes
Files modified
.github/workflows/pre-commit.yaml.pre-commit-config.yamlci/auto-generate-readme.shFunctional modifications
.github/workflows/pre-commit.yamluses: actions/checkout@v3because it's not needed for the pre-commit hooks to run..pre-commit-config.yamlv4.6.0committo avoid running it on pushes--that's redundant.ci/auto-generate-readme.shset -eto make the script exit immediately if a command exits.git commit -smotion that's more familiar for contributors.