Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to ReviewNB to Code Review section. #247

Merged
merged 3 commits into from
Dec 22, 2021
Merged

Add reference to ReviewNB to Code Review section. #247

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4197a94
Add reviewing of ReviewNB to Code Review section.
svenvanderburg Jun 29, 2021
8e6c263
Update best_practices/code_review.md
svenvanderburg Dec 22, 2021
ebd19ba
Update best_practices/code_review.md
svenvanderburg Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions best_practices/code_review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,14 @@ 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, because Github shows differences between Jupyter notebooks as a diff between json files.
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.

## References

Atwood, Jeff (2006) [Code Reviews: Just Do It](http://blog.codinghorror.com/code-reviews-just-do-it/)
Expand Down