GitHub Repository Setup

The framework for the Lab part of this course is available as a template on GitHub. To create your own (private) repository from this template, follow these steps:

  1. Open the Framework Repository in your browser and sign in to GitHub (if not yet signed in).

  2. Click the green "Use this template" button and choose "Create a new repository"

  3. Enter some more-or-less meaningful name in the "Repository name" field (e.g., "vu-co-lab")

  4. Choose "Private" from the bottommost options!!

  5. Click "Create repository"

Done! You now have your own (private) repository containing the framework needed for the assignments. Continue with the Technical Setup, during which it will be explained how to clone this repository such that you have the framework files on your computer.


Why Git(Hub) Though?

There are several reasons to use a version control system (VCS) for development projects - including projects where you work (mostly) alone:

  1. Your code is "safe" - most VCSs offer easy-to-use cloud storage of your files. Thus, you do not have to make backups.

  2. If things go wrong, it is easy to trace back your development steps.

  3. When cooperating with others, a VSC allows for automatic merging of concurrent changes (even to the same files) from different editors. So changes of one person are never accidentally overwritten by someone else - or at least not without a warning.

  4. If you want or have to show that your (cool) work is your own, having a development history greatly helps your case (e.g., job interviews, academic applications, plagiarism suspicions, etc.). Accordingly, it is the de-facto standard in the field to develop all relevant projects in a VCS - if you do not know how to use it well, or you are not using it at all, you have a significant disadvantage in comparison to most other developers.

For this course, it is expected that you are able to show a Git commit history for all assignments. Our official suggestion is a commit frequency of 30 work minutes or, even better, every logical code block. Feel free to deviate at your own discretion - however, in some cases, we might reject submissions based on an insufficient ability to show your development process.


Help! I don't know how to use Git...

You may have never worked with Git before and don't know how to use it or where to start. There are many great Git and GitHub guides available on the web (probably even on TikTok), for example this Git Guide by GitHub.

Try to get a basic understanding of how to use Git and GitHub before starting your work on the assignments. Git may have a bit of a learning curve, but you will need to learn it at some point in your career - may as well do it sooner rather than later.

VS Code natively supports Git repository control through the GUI. While it is important that you know how to use the Git commands in a terminal, the GUI offers many handy features (such as easily viewing the changes to your code since the last commit). The VS Code Documentation includes a page explaining how to use the Git GUI.

Last updated