Skip to content
New issue

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

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

Already on GitHub? # to your account

Add reference to ReviewNB to Code Review section. #247

Merged
merged 3 commits into from
Dec 22, 2021
Merged
Changes from 1 commit
Commits
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
7 changes: 7 additions & 0 deletions best_practices/code_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
svenvanderburg marked this conversation as resolved.
Show resolved Hide resolved
You can use [ReviewNB](https://www.reviewnb.com/) for that. If you configure
svenvanderburg marked this conversation as resolved.
Show resolved Hide resolved
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.
Copy link
Member Author

@svenvanderburg svenvanderburg Jun 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if we should add the 2nd part about the academic plan. It is nice to know for escience center staff, but it is ofcourse not a generally applicable best practice.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The NLeSC guide should be targeted at NLeSC staff. All generic stuff should be in The Turing Way instead. So it's okay to suggest NLeSC specific things.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check!


## References

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