Add pre-commit to dependencies with appropriate config #892
Conversation
|
@spjuhel Do I recall correctly that you wanted to help with the documentation? Can we work together on it soon? |
|
Yes! I can find some time tomorrow afternoon or Friday anytime. |
|
@ValentinGebhart @luseverin @DahyannAraya Would anybody of you be interested in reviewing the additions to the Installation, Git, and Climada Conventions guides? We would be glad about input from people outside the core development team. |
|
I read through the I guess the |
luseverin
left a comment
There was a problem hiding this comment.
Hi guys,
I followed the updated guide and installed the pre-commit and black plugins for VScode. Let me know if this was the expected outcome! I also highlighted a couple typo in my review, and added a couple comments for clarifications:
- Is it required to also install
isortseparately? - Shouldn't be
blackalready be mentionned in the installation guide alongside the suggestion to install thepre-commitplugin ?
Unfortunately I did not have a branch to reformat with black at the moment but the instruction for reformatting a branch seemed clear to me.
Otherwise, I have nothing to add. Nice work!
ValentinGebhart
left a comment
There was a problem hiding this comment.
To me the documentation changes are pretty clear. I followed the installation of the pre-hooks and tested them, they seem to work. I did not test the instruction for "How do I update my branch if it is not up to date with the formatted Climada?" but it also seems reasonable.
|
@manniepmkam Thank you for the updates!
😂 I did not even realize! Not sure what that is supposed to mean, we'll leave it as is for now. |
Changes proposed in this PR:
This PR fixes #
This PR will remain a Draft until after the next release.PR Author Checklist
develop)PR Reviewer Checklist