Update pre-commit documentation #16
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. Use pre-commit to install & run black, flake8, etc Pre-commit tool versions will diverge between projects, so installing / running them from a single shared install in the system Python will lead to unexpected failed commits 2. Add Advanced.md Existing reference to ART's pre-commit documentation is broken following recent updates to ART. Copied relevant commands here to make DemoRepo self-contained. Also added suggested workflow for ignoring commit hooks when necessary, though "highly discouraged" & purposefully buried at the end of this advanced document.
chimaerase
force-pushed
the
pre-commit
branch
from
8adffa0
to
9ccf2bd
Compare
mhgarci1
approved these changes
Jun 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR should be reviewed / merged after #14, which applied basic formatting changes to the entire README file.
Update pre-commit documentation
Pre-commit tool versions will diverge between projects, so installing / running them from a single shared install in the system Python will lead to unexpected failed commits
Existing reference to ART's pre-commit documentation is broken following recent updates to ART. Copied relevant commands here to make DemoRepo self-contained. Also added suggested workflow for ignoring commit hooks when necessary, though "highly discouraged" & purposefully buried at the end of this advanced document.