README.md

GitHub-Einführung für SchülerInnen

Herzlich willkommen zu diesem GitHub-Tutorial! 😊

In der heutigen digitalen Welt ist das Verständnis von Versionierung und Kollaboration bei der Softwareentwicklung unerlässlich. Egal, ob du ein angehender Entwickler, ein Schüler, der an einem Projekt arbeitet, oder einfach nur neugierig bist, dieses Tutorial wird dir die Grundlagen von GitHub näherbringen.

GitHub ist nicht nur ein Werkzeug für professionelle Entwickler. Es kann auch für Schulprojekte, Gruppenarbeiten oder persönliche Projekte genutzt werden. Es hilft dir, deinen Code zu organisieren, Änderungen zu verfolgen und mit anderen zusammenzuarbeiten.

In diesem Tutorial lernen Sie:

• Commit: Ein "Commit" ist im Kontext von Git eine Momentaufnahme Ihres Codes. Es dokumentiert die Änderungen, die Sie vorgenommen haben, und ermöglicht es Ihnen (und anderen), zu einem bestimmten Zeitpunkt in der Entwicklungsgeschichte Ihres Projekts zurückzukehren. Mehr dazu hier.
• Branch: Eine "Branch" (deutsch: Zweig) ermöglicht es Ihnen, an neuen Features oder Bugfixes zu arbeiten, ohne den Hauptcode (oft "master" oder "main" genannt) zu beeinflussen. Dies ist nützlich, um sicherzustellen, dass der Hauptcode stabil bleibt. Mehr dazu hier.
• Pull-Request: Ein "Pull-Request" ist eine Methode, um Änderungen, die Sie in einem Branch gemacht haben, in den Hauptbranch zu integrieren. Es ist auch eine Möglichkeit, Ihre Änderungen zur Überprüfung und Diskussion vorzulegen, bevor sie in den Hauptcode aufgenommen werden. Mehr dazu hier.

Lassen Sie uns beginnen!

---

Ziel: Sie sollen lernen, wie man einfache Fehler in Dokumentationsdateien korrigiert und diese Änderungen in ein Git-Repository einpflegt.

Ausgangssituation:

Project
|-- documentation.md
|--hello-world.cs
README.md

1. Repository-Erstellung

Was sind Repositorys?
Ein Repository (oft einfach "Repo" genannt) ist im Kontext von GitHub ein Speicherort oder Container, in dem alle Dateien für ein bestimmtes Projekt gespeichert werden. Es enthält alle Versionen dieser Dateien, sodass Sie Änderungen über die Zeit verfolgen können. Das ermöglicht es mehreren Personen, an einem Projekt zu arbeiten und ihre Änderungen auf eine organisierte und kollaborative Weise zu verwalten.

In Bezug auf GitHub Classroom:

Wenn Sie diesen Leitfaden durchlaufen, gehen wir davon aus, dass Sie bereits ein Repository über GitHub Classroom erstellt haben. GitHub Classroom ist ein Tool, das speziell entwickelt wurde, um den Unterrichtsprozess für Lehrer und Schüler zu vereinfachen. Wenn Sie über einen Link in GitHub Classroom ein Repository erstellen, wird es automatisch auf "internal" gestellt. Das bedeutet, dass das Repository privat bleibt und nur von den eingeladenen Personen eingesehen werden kann.

Die Erstellung von Repositorys und deren detaillierte Konfiguration sind ein eigenes großes Thema und werden in einem kommenden Tutorial ausführlich behandelt. Für jetzt ist es ausreichend zu wissen, dass Sie ein Arbeitsumfeld haben, in dem Sie Ihre Codeänderungen sicher speichern können.

---

2. Änderungen committen

• 1. Datei Ändern
  • In der 'hello-world.cs' Datei gibt es einen Schreibfehler, den Sie korrigieren sollen. Korrigieren Sie den Text, indem Sie "Morld" durch "World" ersetzen.
• 2. Änderung übernehmen
  • Committen Sie Ihre Änderung indem Sie auf den "Commit changes..." - Button clicken.
    
  • Geben Sie in einem Commit immer ein Commit-Text an, welcher beschreibt, welche Änderung gemacht wurde.
• 3. Commits ansehen
  • Clicken Sie auf commits und sehen sie alle commits auf main ein.
    
  • Clicken Sie auf Ihren letzten Commit und sehen Sie die Änderung ein.
  • Hinterlassen Sie einen Kommentar,in der von Ihnen geänderten Zeile (Zeile wird grün angezeigt). Der kommentar könnte folgendermaßen aussehen: # Meine erster GitHub Commit :100: Die Formatierung geschied bei GitHub immer im Markdown-Format.
    
  • Gehen Sie zu der Datei 'hello-world.cs' und kopieren Sie den Link zu diser Datei indem Sie anclicken und anschlißen ' copy permalink' anklicken.
  • Gehen Sie zu der Datei 'documentation.md' und fürgen Sien den Link unter die Codezeile.

---

3. Neue 'Branch' erstellen

• 1. Branch erstellen
  • Clicken Sie obe auf die Main-Branch und erstellen Sie eine neu Branch mit dem Namen 'neues_feature'
    
  • Wenn Sie jetzt die Branch 'main' und 'neues_feature' vergleichen, wird Ihnen auffallen, dass in beiden Zweigen die Dateien gleich sind.
• 2. 'Änderung in neuer Branch
  • Gehen Sie sicher das Sie sich in der neuen Branch befinden.
    
  • Gehen Sie zu der Datei 'hello-world.cs' und fügen sie fogende Zeile zur bestehenden hinzu:

    Console.WriteLine("Mein neues Feature");

  • Commiten Sie wieder die Änderung wieder mit dem "Commit changes..." - Button.
    
  • Vergleichen Sie wieder beide Branches und schauen Sie, ob die Dateien die gleichen sind.

---

4. Pull-Request erstellen

• 1. Pull-Request

  • Wählen Sie die Branch aus, in der Sie ihr neues Feature umgesetzt haben. Anschließend klicken Sie auf 'contribute' (beitragen)
    
  • Clicken Sie auf 'Open pull-request' um eine Anfrage an die main-Branch zu schicken.

• 2. Pull-Request-formulieren

  • Achten Sie darauf, dass die Anfrage von 'neues_feature' auf 'main' gestellet wird base:main <- compare:neues_feature
  • Fügen Sie einen Text hinzu.
  • Klicken Sie auf 'Create pull request'
    

• 3. Pull-Request-mergen Sie haben nun eine Anfrage gestellt die Änderungen von 'neues_feature' auf 'main' zu übernehmen.

  • Rufen Sie alle Anfragen auf, indem sie auf 'pull requests' klicken.
    
  • Schauen Sie welche Änderung die Anfrag enthät indem sie auf 'Files changed' klicken.
    
  • Zurück auf 'conversation' können Sie, den Änderungen zustimmen. Die Branch 'neues_feature' wird mit der Branch 'main' gemerged (verschmolzen). Hierfür klicken Sie auf 'Merge pull request'.
    
  • Vergewissern Sie sich das die Änderungen in die main-Branch übernommen wurden.