2. Reviewing pull requests

You can see all the open pull requests under the "Pull requests" tab. These are essentially modifications or updates a contributor has made, that need to be reviewed to ensure, for example, that the recipe is well documented and understandable, that it runs, that it contains no bugs, etc. Check out our tips for reviewing here.

Add yourself as a reviewer on the 'Reviewers" tab on the left.

Create a branch with the pull request

On the upper right corner of the Pull Request page, you will find a "Code" button. When you click on it, you will see you can copy something like this:

gh pr checkout 417

but instead of 417 you will have another number corresponding to your pll request. Run that line above in your gadi session. This will allow you to run the code that you are reviewing in gadi. You might be prompted with the following error message: please run gh repo set-default to select a default remote repository. If so, simply run please run gh repo set-defaultand selectCOSIMA/cosima-recipes` as the default.

Verify that it runs without error messages, look out for bugs and see that it is will documented.

Add your reviewer comments

In the Pull Request page, you will see that there is a review-notebook-app bot that creates a ReviewNB link. You can click on it to comment on specific lines of code. Comment away! Once you are done with the reviews at the top of the page you will see an "Add your review": button. Click on it, comment something like "See comments on ReviewNB" and hit the "Request changes" option.

If you can't find the "Add your review" button at the top of the page it is because you have not added yourself as a reviewer.

Approve once you are satisfied

Use the "Add your review" button, but with the "Approve" option.

Thank you for reviewing!