• Home
  • About
  • Schedule
  • Sessions
  • Team
  • Resources
  • Mechanics
  • FAQ
  • Code of Conduct
  • Acknowledgements

Contents

  • 1 Background
  • 2 Assignment
    • 2.1 Editing content on GitHub
      • 2.1.1 Create a README.md file
      • 2.1.2 Clean up your recipes repository
    • 2.2 Forking
  • 3 Bonus: Tags and Releases

Extra Assignment: Advanced GitHub

Chapter: GitHub Survey: GitHub

1 Background

If you missed more than two course sessions, you are asked to complete an additional assignment. This additional assignment builds on the contents of previous course sessions and is (roughly) the equivalent of what you would complete in a regular course session. If you need help, please consult the relevant chapters in the Version Control Book (in particular the chapter on GitHub). While the assignment covers many aspects of our course, it’s not an exam. So please get in touch if you are getting stuck or have any questions about the assignment or the course contents.

Submission Deadline: Friday, Feb 2nd, 2024

2 Assignment

2.1 Editing content on GitHub

2.1.1 Create a README.md file

If you did not create a README.md file in your recipes repository already:

  1. Go to your recipes repository’s main page and click on “Add a README”.
  2. Use Markdown syntax and add the most important facts about the repository.
  3. Click on “Commit changes” and write a relevant commit message.

2.1.2 Clean up your recipes repository

If you have unnecessary files in your recipes repository:

  1. Click on the file you want to delete and choose “Delete file”.
  2. Commit the change and choose a commit message.
  3. Pull the changes to your local repository (i.e., to your computer).

You complete this assignment by sending a link to your recipes repository to Lennart.

2.2 Forking

  1. Find out what forking is.
  2. Fork Lennart’s recipes repository.
  3. Create an issue in Lennart’s repository (maybe the repo is missing a great recipe?).
  4. Clone the forked repository to your computer.
  5. Create a new branch and make one or multiple commits, “fixing” the issue.
  6. Push your changes to GitHub.
  7. Create a pull request with your changes (hint: from the forked to the original repository) and refer to the issue.

You complete this assignment by sending a pull request to Lennart’s recipes repository from a fork.

Hint: Check out Matteo’s contribution to Lennart’s recipes repository for a similar procedure.

3 Bonus: Tags and Releases

This is a bonus assignment. It’s not required to make up for more that two missed course sessions. But maybe you are on a roll now, so why not?

  1. Read the Tags and Releases chapter.
  2. Create a tag, marking the current version of your recipes repository.
  3. Create a release of your tagged repository version on GitHub.
  4. Try out the Zenodo Sandbox to generate a DOI for your repository.
© 2023 – 2024 Dr. Lennart Wittkuhn
  • Funded by the Digital and Data Literacy in Teaching Lab
License: CC BY-SA 4.0