[infra] Add black checks to CI and pre-commit hooks #218
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
cqc-melf
reviewed
Jan 24, 2023
There was a problem hiding this comment.
I think the right place to point this out for other would be a new created CONTRIBUTING.md file like in the tket repo at https://github.com/CQCL/tket/blob/develop/CONTRIBUTING.md
I have added a few comments and questions, let me know if something is unclear.
Thank you for adding this!
cqc-alec
reviewed
Jan 25, 2023
cqc-melf
reviewed
Jan 25, 2023
cqc-melf
reviewed
Jan 25, 2023
cqc-melf
reviewed
Jan 25, 2023
cqc-alec
requested changes
Jan 26, 2023
CONTRIBUTING.md
Outdated
| changes on the `main` branch, and open a PR from your fork. If it passes | ||
| the checks and is accepted after review, it will be merged in. | ||
| If there are any changes to the manual part of the repo the | ||
| manual needs to be rebuild locally. |
There was a problem hiding this comment.
Suggested change
| manual needs to be rebuild locally. | |
| manual needs to be rebuilt locally. |
There was a problem hiding this comment.
Thx for fixing it @cqc-melf :D !
Co-authored-by: Alec Edgington <[email protected]>
cqc-melf
approved these changes
Jan 26, 2023
cqc-alec
approved these changes
Jan 26, 2023
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.
Fixes #165.
Besides adding a black check step to the CI (
check-examples.yml), this PR also adds a.pre-commit-config.yamlnecessary for enabling the pre-commit hooks.pre-commitis added to therequirements.txt. So, after installing all the requirements, you can just usepre-commit installto have the checks run automatically before every commit. I've run it for all the python files and added the fixes to this PR.I think we should mention the process of installing the
pre-commithooks, but I'm not sure if theREADME.mdis the best place to do so (I don't see any dev-related section there).