COSIMA Hackathon 2025 - G2 training

COSIMA
1

About

This is material to support training for the G2 group at the COSIMA hackathon v5.0, 8th Sept 2025.

Contributions to COSIMA Recipes are typically made using pull requests, a mechanism for contributing your own code to a repository via GitHub. This training session is aimed at people who are new to making pull requests.

No prior knowledge is assumed, and by the end, you will have made a pull request to a demo repository, which uses the same mechanism that you can use to contribute to cosima-recipes (or any other repository on GitHub!).

Prerequisites

Please follow the prerequisites here. For this session, only 1. and 4. are needed.

On the day

The training session will walk through the guide in this github repository, which contains all the session materials.

Outline

  1. Forking a repository
    • We will create our own version (a fork) of a repository, that we can then contribute back to the original from.
  2. Creating a new branch
    • We will use git to create a new branch, which lets us make changes in an isolated environment on our local machine.
  3. Pushing changes
    • We will send our local isolated changed to our version of the repository.
  4. Creating a Pull Request
    • We will use a Pull Request to contribute our changes back to the original/main repository.
2

People in Group 2 might find the COSIMA Recipes wiki a useful reference for after this training session. It has git cheat sheet instructions for forking, cloning and contributing.

Also please edit or give feedback to the wiki instructions if you see how they could be improved.