Git Workshop

Morning session (10:00 - 12:00)

Introduction to git, Github, git clients and Github repositories

Afternoon session (13:30- 16:00).

Requirements

• Computer with an internet connection
• Git software installed on computer

For Mac

• Install command-line git. On Mavericks (10.9) or above from Terminal try to run git.
  

  $ git --version

  If you don’t have it installed already, it will prompt you to install it.
• Install Git Desktop (Optional) NB This is also another way to install the command-line git client.
  Download from the Desktop web-site(https://desktop.github.com)
  

For Windows

• Install command-line git from this web-site: https://git-scm.com/download/win
  
• Install Git Desktop (Optional) NB This is also another way to install the command-line git client.
  Download from the Desktop web-site(https://desktop.github.com)
  

For Linux

On Fedora (or similar RPM-based distribution e.g. RHEL or CentOS)

$ sudo dnf install git-all

On a Debian-based distribution (e.g. Ubuntu

$ sudo apt install git-all

Markdown, Github Web-pages & Github Wikis

Practical - live-coding session using Markdown.

• Using Markdown to create a Github Page (practical - live-code a Page).
• Using Markdown to create a Github Wiki (Practical - live-code a Wiki).

Creating good READMEs

• What makes a good README? (Discussion).
• (practical/discussion) Take an example and go through it.
  • What do you like?
  • what do you not like?
    Further examples and reading.
    1 Gist template of a ‘good’ README.
    2 Medium article: A Beginners Guide to writing a Kickass README.
    3 Curated list of good READMEs.

Issue tracking and continuous integration.

• Issue Tracking – GH helping you manage bugs (AP)
• Demo - continuous integration - GH and Travis helping you test your code continuously

Licencing.

• Why do we licence?
• Who are we licencing to?
  • Treefinder: Example of licence restriction based on politics.
• Couple of exercises:
  • Whiteboard brainstorming exercise – what software licences have you heard of or come across?
  • Allocate a licence to groups and get them to find a copy of it. Quick (3 min presentation of why it would/would not meet the needs of their software project)- (Ditch this one if time is short).

Slides used from SoftwareSaved.
• Practical - take a Flashcard. Look at the scenario printed on it - in your group discuss and decide upon which if any licence is best. (Quick report back if time}.
You can print the cards using this file.

Course wrap-up

• What have we learnt this afternoon?
  Further reading: Github learning.

Extra links

• Create website for you and your project
• Configure automated Docker builds from GitHub
• Travis documentation
• Choose a license
• Choose a creative commons license