All Images

Introduction

Issues

Figure 1

Issue screen

Figure 2

Creating a new issue

Figure 3

Issue details

Figure 4

Lock & pin issue

Figure 5

You should get a pop-up box looking like this when you enter the # key: Issue linking dropdown Once you’ve selected the existing issue, and created your new one, you’ll get a link to the previous one: Issue linked

Project Management

Figure 1

Link a project to a repository

Figure 2

Creating project details

Figure 3

Adding a column, part 1

Figure 4

Adding a column, part 2

Figure 5

Board fully set up

Figure 6

Where to add issues

Figure 7

Adding existing issues

Figure 8

Adding new cards

Figure 9

Turning a card into an issue

Figure 10

We convert the card to an issue, and add a quick description, then click Convert to issue and select climate-analysis from the dropdown: Convert card to issue Once we’ve made the issue, we can follow the link to see it and add the Documentation label: Select the documentation label

Figure 11

Filtering project board info

Figure 12

Saving updated filters

Figure 13

Issues button

Figure 14

New label button

Figure 15

We type High priority into the box at the bottom of the Todo column: Creating a new card Then we can click and drag to move it to the top of the column: Prioritisation by order in column

Figure 16

Or, we can convert the card to an issue as we did before, then select the High priority label we made earlier: Labelling a new issue Then we have prioritisation by label: Labeled a new issue

Figure 17

Feature-branch workflow

Figure 18

Opening a file in GitHub

Figure 19

Documenting rainfall module

Figure 20

Documenting rainfall module

Figure 21

Documenting rainfall module

Figure 22

Create a fork

Figure 23

Created fork

Release Management

Figure 1

Create a releaseRelease details

Figure 2

Release details

Figure 3

Release details

Figure 4

First, making sure we’re on sandbox.zenodo.org, we need to sign up using our GitHub account - using Log in or Sign up, and and selecting GitHub. Log-in buttonLog-in via GitHub

Figure 5

Once you’ve logged in, selecting GitHub from the drop-down menu opens a list of your repositories, and we can toggle them to ‘on’ to begin tracking releases on them. Select GitHubEnable your repository

Figure 6

Zenodo won’t retroactively generate DOIs for releases, so we need to head back to GitHub, and create a new release, then go back to Zenodo and click on our repository to see the status of our upload. Create a releaseRelease processing

Figure 7

Depending on how busy Zenodo is, this can take anything from minutes to hours to process. Once it’s done, though, you get a DOI, which we can then edit into the message for our release. Release processedEditing a release

Figure 8

Now, when we check on GitHub, there’s a button that provides a BibTex (or APA) format citation for your code. Citation instructions

Writing Sustainable Code

Managing a Mini-Project

Figure 1

Selecting the settings tabEnabling issues

Figure 2

No dev branch

Figure 3

We’ll go to the Issues tab of our project-novice-demo, repository, select New Issue, then create an issue. We can even link our issue directly to our project board from here: Creating and linking an issue

Figure 4

Moving to in progress column

Figure 5

Moving to done column

Figure 6

List of branches on GitHub

Figure 7

New branch on GitHub

Figure 8

New branch details

Figure 9

Pull request target

Figure 10

  • Go to our README.md file on GitHub, and switch to the dev branch version of it Switch to the `dev` branch

    • Figure 11

  • Edit the file on GitHub to put in the correct URL (google it!) Edit directly on GitHub

    • Figure 12

  • Submit your changes as a new branch, and create a pull request Submit as a new branch

    • Survey