Adding contributing doc and pre-commit #73
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
sweco
reviewed
Feb 19, 2024
There was a problem hiding this comment.
Thanks for the initiative @pgoslatara. I left a few comments. I also added aa808c4 where I add pre-commit, black and isort also to pyproject.toml in case someone wants to run them manually from the CLI. Let's discuss and iterate.
sweco
reviewed
Feb 22, 2024
|
@sweco Is this good to merge or does it need another revision? |
sweco
approved these changes
Mar 13, 2024
|
Thanks @pgoslatara, will release this. 😊 |
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.
I really like this repo, however there is no guide for contributors. This PR adds a section to the
READMEwith a guide on how to setup a local development environment and how to run the integration tests locally. In addition, in order to maintain standard formatting and linting conventions,pre-commitis introduced withblackandisort. The GitHub workflows now reflect this change, instead of calling justblack,pre-commitis run, this will enable adding further hooks in the future (if desired).