Contributing Code During the Hackathon

Please add your hackathon work under 5_Hackathon_Code/.

Open the Repository¶

Start by opening the hackathon repository with the workspace git-puller link. This will clone the repository for you if it is not already available in your workspace:

https://workspace.polar-hackathon.hub-otc-sc.eox.at/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2FESA-EarthCODE%2Fpolar_hackathon&urlpath=lab%2Ftree%2Fpolar_hackathon%2F0_Introduction%2Fintro.ipynb&branch=main

The main hackathon repository is:

https://github.com/ESA-EarthCODE/polar_hackathon

Fork the Repository¶

After the repository is open in your workspace, create your own fork of the main repository on GitHub. Your fork will look like:

https://github.com/<your-github-username>/polar_hackathon

GitHub Docs: Fork a repository

Then change the local workspace repository so origin points to your fork:

git remote -v
git remote set-url origin https://github.com/<your-github-username>/polar_hackathon.git
git remote -v

Keep the main hackathon repository as upstream so you can pull updates:

git remote add upstream https://github.com/ESA-EarthCODE/polar_hackathon.git

If upstream already exists, skip that line.

GitHub Docs: Managing remote repositories

Commit Your Work¶

Run these commands in a terminal, not inside a notebook:

git switch -c <branch-name>
git status
git add 5_Hackathon_Code/
git commit -m "Add hackathon contribution"
git push origin <branch-name>

Choose a short branch name that describes your work, for example add-sea-ice-notebook. Your changes are pushed to your fork, not to the main hackathon repository.

GitHub Docs: Set up Git

GitHub Docs: Pushing commits to a remote repository

Open a Pull Request¶

Open a pull request from your fork’s branch into the main hackathon repository:

https://github.com/ESA-EarthCODE/polar_hackathon/pulls

GitHub Docs: Creating a pull request

After creating the pull request, check that it appears on the pull request list and follow up on any review comments.