From 4197a94c38f1aa54055b5c76f732f972d82426d3 Mon Sep 17 00:00:00 2001 From: Sven van der Burg Date: Tue, 29 Jun 2021 15:06:18 +0200 Subject: [PATCH 1/3] Add reviewing of ReviewNB to Code Review section. --- best_practices/code_review.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/best_practices/code_review.md b/best_practices/code_review.md index 9c079cfc..69fce806 100644 --- a/best_practices/code_review.md +++ b/best_practices/code_review.md @@ -297,6 +297,13 @@ In all cases, file many small pull requests, not one big one, as GitHub's support for code reviews is rather limited. Putting too many issues into a single pull request quickly becomes unwieldy. +## Reviewing Jupyter notebooks with ReviewNB +For rich diffs and commenting on Jupyter notebooks Github is not very useful. +You can use [ReviewNB](https://www.reviewnb.com/) for that. If you configure +your esciencecenter.nl email address as your primary email for your Github +account [here](https://github.com/settings/emails) you have access to the +academic plan with full benefits. + ## References Atwood, Jeff (2006) [Code Reviews: Just Do It](http://blog.codinghorror.com/code-reviews-just-do-it/) From 8e6c263889a68a2fbd406376990aa7c1a1d72f2b Mon Sep 17 00:00:00 2001 From: Sven van der Burg Date: Wed, 22 Dec 2021 14:27:55 +0100 Subject: [PATCH 2/3] Update best_practices/code_review.md Co-authored-by: Carlos Martinez --- best_practices/code_review.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/best_practices/code_review.md b/best_practices/code_review.md index 69fce806..38095d84 100644 --- a/best_practices/code_review.md +++ b/best_practices/code_review.md @@ -298,7 +298,7 @@ support for code reviews is rather limited. Putting too many issues into a single pull request quickly becomes unwieldy. ## Reviewing Jupyter notebooks with ReviewNB -For rich diffs and commenting on Jupyter notebooks Github is not very useful. +For rich diffs and commenting on Jupyter notebooks Github is not very useful, because Github shows differences between Jupyter notebooks as a diff between json files. You can use [ReviewNB](https://www.reviewnb.com/) for that. If you configure your esciencecenter.nl email address as your primary email for your Github account [here](https://github.com/settings/emails) you have access to the From ebd19ba8b7db2b939dbd20b1263be31f7dd00128 Mon Sep 17 00:00:00 2001 From: Sven van der Burg Date: Wed, 22 Dec 2021 14:28:03 +0100 Subject: [PATCH 3/3] Update best_practices/code_review.md Co-authored-by: Carlos Martinez --- best_practices/code_review.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/best_practices/code_review.md b/best_practices/code_review.md index 38095d84..6956e3b5 100644 --- a/best_practices/code_review.md +++ b/best_practices/code_review.md @@ -299,7 +299,8 @@ single pull request quickly becomes unwieldy. ## Reviewing Jupyter notebooks with ReviewNB For rich diffs and commenting on Jupyter notebooks Github is not very useful, because Github shows differences between Jupyter notebooks as a diff between json files. -You can use [ReviewNB](https://www.reviewnb.com/) for that. If you configure +You can use [ReviewNB](https://www.reviewnb.com/) for reviewing Jupyter notebooks. ReviewNB shows the diff between notebooks in a human readable way. + If you configure your esciencecenter.nl email address as your primary email for your Github account [here](https://github.com/settings/emails) you have access to the academic plan with full benefits.