Lernziele

Sie kennen die Begriffe Git, GitHub, Open-Source Software, Markdown und können diese anhand eines Beispiels in Verbindung setzten

Sie können ihren eigenen Code (inkl. Kommentare und Markdown-Dokumentation) auf GitHub veröffentlichen

Experiment - Was macht dieser Algorithmus?


Timer (1 Min.)

Klicken Sie auf den folgenden Link und versuchen Sie alleine herauszufinden, was der Algorithmus genau macht:

https://allocate.monster/STOZYTST

Guter Code ist kommentierter Code

Kommentare helfen, den Code zu verstehen. In Python starten Kommentare mit einem # und sollten in ganzen Sätzen (erstes Wort gross) geschrieben werden, z. B.

# Gut

# Dieser Loop berechnet die 7er-Reihe bis 1000 (1x7, 2x7, 3x7…)
for i in range(int(1000 / 7)):
   print((i + 1) * 7)


# Schlecht

# loop bis 1000
for i in range(int(1000 / 7)):
   print((i + 1) * 7) # berechne (i+1)*7

Was ist Open-Source Software?
Was ist Markdown?

Umfrage: hier klicken

Was ist Git?

  • Kollaborations- und Versionsverwaltungstool für Softwareentwickler (vgl. Google Docs)
  • 2005 von Linux-Gründer Linus Torvalds entwickelt
  • Konsolenanwendung, aber es gibt auch GUIs
  • De-Facto Standard in der Softwareindustrie

Was ist GitHub?

  • Hosting Service für Git
    (also eine Website, welche einen Git-Server zur Verfügung stellt)
  • De-Facto Standard für Open-Source Software (Linux, LibreOffice…)

Live-Auftrag: GitHub Account Erstellen

Erstellen Sie einen Account auf GitHub (Sign up). Die E-Mail-Adresse muss dabei echt sein, da Ihnen ein Verifizierungscode zugesendet wird.

Was ist ein Git(Hub) Repository?

  • Ein Repository (Repo) ist ähnlich wie ein Ordner
  • Generell gilt: 1 Projekt = 1 Repositorys
  • Ein Repo kann öffentlich oder privat sein

Beispiel Linux:

Live-Auftrag: GitHub Repo Erstellen

Erstellen Sie nun ein GitHub Repositoy (create repository). Geben Sie dafür einen passenden Namen ein und vergessen Sie nicht, “Add a README file” zu wählen.

GitHub, Markdown und das README.md

  • Dokumentationen auf GitHub werden in Markdown geschrieben
  • Das README.md beinhaltet die Dokumentation für das gesamte Repo. Beispiele: Markdownify, GitPoint
  • Markdown Syntax vergessen? Siehe Cheatsheet

Beispiel LibreOffice:

Live-Auftrag: GitHub README Bearbeiten

Bearbeiten Sie nun das README.md (Markdown) und überprüfen Sie in der Vorschau, ob das Resultat Ihren Vorstellungen entspricht. Um die Datei zu speichern, geben Sie eine Beschreibung der Änderung ein und klicken Sie auf “Commit changes”.

Commits und Versionierung

  • Commits beinhalten die Änderung einer/mehrerer Datein (History der Änderungen)
  • Ein Commit sollte so benannt werden, dass klar ist, was geändert wurde
  • Commits sollten in der Befehlsform geschrieben werden

Live-Auftrag: GitHub Datei Hochladen

Laden Sie eine beliebige Datei (z. B. ein Bild oder .py Datei) auf GitHub. Benennen Sie den Commit korrekt und verständlich. Schauen Sie dann, ob ihr Commit erfolgreich hinzugefügt wurde.

Auftrag (ca. 45 Min): Veröffentlichen Sie eines Ihrer Programme (z. B. aus den Aufträgen) auf GitHub

  1. Wählen Sie eines ihrer Programme
  2. Kommentieren Sie ihren Code
  3. Laden Sie den kommentierten Code (.py) auf GitHub
  4. Dokumentieren Sie ihr Programm im README.md
    • Einleitung: Was macht es und wie wird es benutzt?
      (mind. 3 Sätze + mind. 1 Screenshot)
    • Features: Eine Liste von Features (mind. 3 Punkte)
    • Reflexion: Was haben Sie in den letzten Wochen gelernt und was nehmen Sie mit? (mind. 3 Sätze)
  5. Fügen Sie den Link zu ihrem Projekt hier ein.