Skip to content

Commit

Permalink
Update doc/guide/Guide_Review.ipynb
Browse files Browse the repository at this point in the history
Co-authored-by: viggowat <[email protected]>
  • Loading branch information
sarah-hlsn and viggowat authored Nov 28, 2023
1 parent 91db8c8 commit 6c49bcf
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/guide/Guide_Review.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@
"source": [
"At least one reviewer needs to\n",
"- Review all the changes in the pull request. Read what it's supposed to do, check it does that, and make sure the logic is sound.\n",
"- Check that the code follows the CLIMADA style guidelines `#TODO: link`\n",
"- Check that the code follows the CLIMADA style guidelines \n"
"- [CLIMADA coding conventions](../guide/Guide_CLIMADA_conventions.ipynb) \n"
"- [Python Dos and Don't](../guide/Guide_PythonDos-n-Donts.ipynb) \n"
" - [Python performance tips and best practice for CLIMADA developers](../guide/Guide_Py_Performance.ipynb) \n",
"- If the code is implementing an algorithm it should be referenced in the documentation. Check it's implemented correctly.\n",
"- Try to think of edge cases and ways the code could break. See if there's appropriate error handling in cases where the function might behave unexpectedly.\n",
"- (Optional) suggest easy ways to speed up the code, and more elegant ways to achieve the same goal.\n",
Expand Down

0 comments on commit 6c49bcf

Please sign in to comment.