Skip to content

Getting started with GitHub

Introduction

For programming you need an environment that allows you to store your work, collaborate with colleagues, be able to define pipelines (way of ensuring the quality of your product/service) as well as going easily back to working versions. In this course we will leverage GitHub infrastructure for our practical work.

What you’ll build

In this codelab, you will get started with your assignment on GitHub: learning (the basics of) git and solving an issue.

What you’ll learn

  • How to create - if need be - a GitHub account
  • How to work with git
  • How to use GitHub Classrooms

What you’ll need

  • A Windows environment for installing git and editing a git project.
  • An internet connection.
  • Some prior basic knowledge of command line usage.
  • Curiosity and motivation to get things working.

Installation of required software components

  • First of all, under sharepoint state what your github username is.
  • Subsequently, head to git-scm to get the git installation.
  • Obviously, unless you have one already, go to GitHub Sign-Up and create a github account for yourself before filling in the information about your github username.

Tip

Did you know that as student you are entitled to a large set of advantages? Check out https://education.github.com/pack#offers and see what it available! The advantages span courses to professional tools.

Getting your hands dirty

You are now ready for the assignment. Go ahead and:

  • Go to the url shown by the professor and click on your name

  • Pick your name from the list, link it to your GitHub account and accept the assignment

  • After a little while, a git repository is ready for you. Read the description what git and GitHub are and how to use them. That is, read carefully the content of the README.md file contained in the project you have just received. With it you should be able to have sufficient understanding about the workings of both git and GitHub

  • Subesequently, clone the repository you will be given to your local machine

  • Solve the one issue (named Git Starter Exercice) that is present in your newly created project. That is :

    • creating an issue1 branch
    • in the newly created issue1 branch, create an empty test.txt file (do not forget to switch to the branch issue1 when doing so
    • commit your changes to issue1
    • merge issue1 into main
    • tag the newly created work with 1.0
    • push your creation

If you will have done all correctly, the automated tests will show the corresponding result. In case of successful tests, you will see

Otherwise you will be able to see the details under

Tip

The tests that are run can be checked out, and even run manually, as they are located in your repository under tests/test.sh.