Collaboration on GitLab / GitHub

Session 07

Starts at:

15:00

Slides Chapter: GitHub - Advanced Chapter: Issues Quiz

This session

In this session, you will work on the following tasks:

  1. Reading: Read the chapter “GitHub - Advanced” in the Version Control Book.
  2. Implementation: Try out the commands in the chapter.
  3. Exercises: Work on the exercises for the recipes project.
  4. Quiz: Test your knowledge with the quiz.

As always:

  1. Try out the commands of this session and play around with them.
  2. Check whether you have achieved the learning objectives.
  3. Ask questions!
  4. Let’s git started!

Learning objectives

GitHub - Advanced

💡 You can fork a repository.
💡 You know the purpose and components of a Pull Request.
💡 You can create a Pull Request from a forked repository.
💡 You know how to collaborate using the popular workflow strategy GitHub flow.
💡 You know the purpose and components of a README file.
💡 You can protect your main branch.

Issues

💡 You understand the purpose of GitHub Issues.
💡 You can create and manage Issues.
💡 You can reference an Issue in another issue.
💡 You can close an Issue with a commit or pull request.

recipes project

At the end of this session, you should have accomplished the following:

  1. You forked a public / internal recipes repository of another course participant.
  2. You opened an Issue in another repository.
  3. You opened a pull request with changes that “fix” the Issue you opened.

Please keep the recipes folder! We will continue to use it in the following sessions.

Exercises

1. “Public” collaboration with pull requests (using a Fork)

  1. Find out what forking is
  2. Fork the recipes repository of another course participant (who is not your partner from the previous exercise)
  3. Create an issue, suggesting a missing recipe
  4. Create an issue in your partner’s repository (maybe their repo is missing a great recipe?)
  5. Repeat the steps from the previous exercise using the forked repository:
    1. Clone the forked repository into a sensible location
    2. Create a new branch and create one or multiple commits “fixing” the issue that you opened
    3. Follow the contributing guide in Lennart’s repo to create a new recipe
    4. Push your changes to GitHub
    5. Create a pull request with your changes (hint: from the fork to the original repo) and refer to the issue in your pull request

2. Review pull requests in your repository

  1. View any pull requests that are created in your recipes repository.
  2. Review the changes made by the contributor in the pull request.
  3. If needed, discuss additional changes with the contributor in the pull request.
  4. Close the pull request by merging the proposed changes.

🚀 Optional: Practice forking on GitHub

  1. Repeat the entire forking workflow (see task 1 above) with Lennart’s recipes repository.

Slides

To print the slides to PDF, do the following:

  1. Toggle into Print View using the E key (or using the Navigation Menu).
  2. Open the in-browser print dialog (CTRL/CMD+P).
  3. Change the Destination setting to Save as PDF.
  4. Change the Layout to Landscape.
  5. Change the Margins to None.
  6. Enable the Background graphics option.
  7. Click Save.

Note: This feature has been confirmed to work in Google Chrome, Chromium as well as in Firefox.

Here’s what the Chrome print dialog would look like with these settings enabled:

Screenshot of Chrome print dialog with the first slide/page of 43 shown on the left, and print options on the right. The Destination print option has Save as PDF selected.

These instructions were copied from the Quarto documentation (MIT License) and slightly modified.

Cheatsheet

Command Description
git remote Manages remote repositories
git clone Creates a local copy of a repository
git pull Fetches and merges the latest changes from a remote repository into the current branch
git fetch Updates remote tracking branches
git push Uploads local commits to a remote repository