Set up the Tutorial on GitHub

To do the tutorial exercises interactively you will need a GitHub account.

If you are not ready to setup a GitHub account and run workflows, a ’take-a-look’ repository with the exercise issues and pull requests is available at take-a-look. You can follow along with the tutorial and read the issues and pull requests without having to run your own GitHub actions. Skip head to the exercises.

For those working through the exercises, this setup guide will take you though forking the tutorial, enabling issues, setting read and write permissions for workflows, and switching on workflows.

Fork the tutorial repository #

The tutorial repository is github.com/scientific-software-reviewers/tutorial

Uncheck Copy the main branch only and click Create fork

You’ll see this message as your fork is being created:

After a few seconds you will see your fork.

Enable issues #

The tutorial makes use of GitHub issues. To enable issues click the Settings tab

Scroll down to features and click Issues:

Enable read and write permissions for workflows #

By default, write permissions are not enabled for workflows. Write permission is needed for the tutorial so the automated actions can be used to create pull requests.

Click the Settings tab

Then Actions -> General on the menu on the left

Then enable read and write permissions for workflows, and allow GitHub Actions to create and approve pull requests and click save:

Switch on Workflows #

The tutorial makes use of GitHub actions to create the exercises. To enable actions, click on the Actions tab and then I understand my workflows, go ahead and enable them.

Great! You are now set to create the tutorial exercises.