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 ReviewNB instructions to readme #119

Merged
merged 4 commits into from
Mar 15, 2024
Merged

add ReviewNB instructions to readme #119

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9689bad
add ReviewNB instructions to readme
JessicaS11 Oct 26, 2022
68cbfed
Update README.md
JessicaS11 Feb 23, 2024
b5b07bb
Merge branch 'main' into reviewnb
JessicaS11 Feb 23, 2024
f017756
Merge branch 'main' into reviewnb
jomey Mar 15, 2024
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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@ You can use this template for your own event!
We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, [continuous integration](./.github/README.md) takes care of converting these files into HTML and publishing the website.


### Additional options to consider
[ReviewNB](https://www.reviewnb.com/) is a great tool for viewing changes in Jupyter Notebooks.
Someone with admin privileges must activate it for each repository you create from this template.
To activate:

1. Go to [reviewnb.com](https://www.reviewnb.com/).
1. Select the "Connect to GitHub" button.
1. Select "+/- REPOSITORIES" from the menu or bottom of the page.
1. Choose the organization where your repo lives.
1. Toggle the "Only select repositories" button and choose your repo from the dropdown.
1. Select "Install".

Great! Now ReviewNB will post a rich-diff of your notebooks each time a PR is opened.


## How to contribute

We are always trying to improve upon this template for future events and welcome contributions. Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md).
Expand Down
Loading