Add some in-situ documentation to pre commit config #1321
+27
−7
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
KelSolaar
reviewed
Jan 7, 2025
There was a problem hiding this comment.
We are running more hooks than this list, technically:
- check-added-large-files
- check-case-conflict
- check-merge-conflict
- check-symlinks
- check-yaml
- debug-statements
- end-of-file-fixer
- mixed-line-ending
- name-tests-test
- requirements-txt-fixer
- trailing-whitespace
- codespell
- isort
- ruff-format
- ruff
- blacken-docs
- prettier
- rst-backticks
- rst-directive-colons
- rst-inline-touching-normal
I'm not super excited by this because we have that configuration in all the repositories that we distribute on Pypi and if we change it here, we need to change it consistently with the other ones so that patching is easier:
- https://github.com/colour-science/colour-demosaicing/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-hdri/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-datasets/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-checker-detection/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-visuals/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-demosaicing/blob/develop/.pre-commit-config.yaml
- https://github.com/colour-science/colour-science.org/blob/master/.pre-commit-config.yaml
and I might have forgotten a few others.
This is generally true for most of our config files, if we do one change, we likely want to propagate it to all the other repositories.
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 helps me see what the current pre-commit config tools are when I happen to need to look at this again in several months.