|
66 | 66 | "metadata": {}, |
67 | 67 | "source": [ |
68 | 68 | "## Installing CLIMADA for development\n", |
69 | | - "\n", |
70 | | - "See [Installation](install.rst) for instructions on how to install CLIMADA for developers. You might need to install additional environments contained in ``climada_python/requirements`` when using specific functionalities. Also see [Apps for working with CLIMADA](../guide/Guide_get_started.ipynb#apps-for-working-with-climada) for an overview of which tools are useful for CLIMADA developers. " |
| 69 | + "\n" |
71 | 70 | ] |
72 | 71 | }, |
73 | 72 | { |
|
85 | 84 | "- the correct sorting of imports using ``isort``\n", |
86 | 85 | "- the correct formatting of the code using ``black``\n", |
87 | 86 | "\n", |
88 | | - "If you have installed the pre-commit hooks (see [Install developer dependencies](install.rst#install-developer-dependencies-optional)), they will be run each time you attempt to create a new commit, and the usual git flow can slightly change:\n", |
| 87 | + "If you have installed the pre-commit hooks (see [Install developer dependencies](../getting-started/install.rst#install-developer-dependencies-optional)), they will be run each time you attempt to create a new commit, and the usual git flow can slightly change:\n", |
89 | 88 | "\n", |
90 | 89 | "If any check fails, you will be warned and these hooks **will apply** corrections (such as formatting the code with black if it is not).\n", |
91 | 90 | "As files are modified, you are required to stage them again (hooks cannot stage their modification, only you can) and commit again.\n", |
|
182 | 181 | "\n", |
183 | 182 | " git checkout -b branch_name\n", |
184 | 183 | "\n", |
185 | | - "### Follow the [python do's and don't](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/Guide_PythonDos-n-Donts.ipynb) and [performance](https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/Guide_Py_Performance.ipynb) guides. Write small readable methods, classes and functions.\n", |
186 | | - "\n", |
187 | 184 | "get the latest data from the remote repository and update your branch\n", |
188 | 185 | " \n", |
189 | 186 | " git pull\n", |
|
201 | 198 | " git commit -m \"new functionality of .. implemented\"\n", |
202 | 199 | " \n", |
203 | 200 | "### Make unit and integration tests on your code, preferably during development\n", |
204 | | - "see [Guide on unit and integration tests](../guide/Guide_Testing.ipynb)\n" |
| 201 | + "see [Guide on unit and integration tests](Guide_Testing.ipynb)\n" |
205 | 202 | ] |
206 | 203 | }, |
207 | 204 | { |
|
313 | 310 | " \n", |
314 | 311 | "12) Update the `develop` branch on your local machine.\n", |
315 | 312 | "\n", |
316 | | - "Also see the [**Reviewer Guide**](../guide/Guide_Review.ipynb) and [**Reviewer Checklist**](../guide/Guide_Review.ipynb#reviewer-checklist)!" |
| 313 | + "Also see the [**Reviewer Guide**](Guide_Review.ipynb) and [**Reviewer Checklist**](Guide_Review.ipynb#reviewer-checklist)!" |
317 | 314 | ] |
318 | 315 | }, |
319 | 316 | { |
|
322 | 319 | "source": [ |
323 | 320 | "## General tips and tricks\n", |
324 | 321 | "\n", |
| 322 | + "Follow the [python do's and don't](Guide_PythonDos-n-Donts) and [performance](Guide_Py_Performance.ipynb) guides. Write small readable methods, classes and functions.\n", |
| 323 | + "\n", |
325 | 324 | "### Ask for help with Git\n", |
326 | 325 | "\n", |
327 | 326 | "- Git isn't intuitive, and rewinding or resetting is always work. If you're not certain what you're doing, or if you think you've messed up, send someone a message. See also our instructions for [Development with Git](Guide_Git_Development.ipynb).\n", |
|
442 | 441 | } |
443 | 442 | ], |
444 | 443 | "metadata": { |
| 444 | + "kernelspec": { |
| 445 | + "display_name": "", |
| 446 | + "name": "" |
| 447 | + }, |
445 | 448 | "language_info": { |
446 | 449 | "name": "python" |
447 | 450 | } |
448 | 451 | }, |
449 | 452 | "nbformat": 4, |
450 | | - "nbformat_minor": 2 |
| 453 | + "nbformat_minor": 4 |
451 | 454 | } |
0 commit comments