Add pre-commit to dependencies with appropriate config

[peanutfun]

Changes proposed in this PR:

• Add configuration for pre-commit (hooks), but do not apply them yet.
• Add documentation on how to install and use pre-commit hooks.

This PR fixes #

This PR will remain a Draft until after the next release.

PR Author Checklist

• Read the Contribution Guide
• Correct target branch selected (if unsure, select develop)
• Descriptive pull request title added
• Source branch up-to-date with target branch
• Documentation updated
• Tests updated
• Tests passing
• No new linter issues
• Changelog updated

PR Reviewer Checklist

• Read the Contribution Guide
• CLIMADA Reviewer Checklist passed
• Tests passing
• No new linter issues

[peanutfun]

@spjuhel Do I recall correctly that you wanted to help with the documentation? Can we work together on it soon?

[spjuhel]

Yes! I can find some time tomorrow afternoon or Friday anytime.

[peanutfun]

@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.

[manniepmkam]

I read through the doc/guide/Guide_CLIMADA_conventions.ipynb, looks good to me.

I guess the doc/guide/Guide_Git_Development.ipynb is not ready yet? I saw quite a few lines with "Chahan will discuss this later!"

[luseverin]

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 isort separately?
• Shouldn't be black already be mentionned in the installation guide alongside the suggestion to install the pre-commit plugin ?

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]

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.

[peanutfun]

@manniepmkam Thank you for the updates!

I guess the doc/guide/Guide_Git_Development.ipynb is not ready yet? I saw quite a few lines with "Chahan will discuss this later!"

😂 I did not even realize! Not sure what that is supposed to mean, we'll leave it as is for now.