Rezept per Pull request einreichen

Für alle, die den Workshop 1 verpasst haben. Etwa 30 Minuten

Im Workshop 1 hat jede Person ihr Rezept in das gemeinsame gitklar-Kochbuch gebracht, über einen eigenen Branch und einen Pull request. Hast du den Workshop verpasst, machst du hier dieselben Schritte allein. Die Aufzeichnung des Workshops zeigt sie ebenfalls. Reich dein Rezept vor dem Workshop 2 ein. Dort lesen wir die Pull requests zu zweit.

Bevor du anfängst

Du brauchst die fertige Vorbereitung: dein Repository rezept-dein-benutzername mit dem Ordner rezept, geklont mit GitHub Desktop nach Dokumente/gitrepos/gh-org-gitklar. Fehlt dir etwas davon, beginne bei der Vorbereitung.

Das Kochbuch ist das Repository gitklar/kochbuch. Alle Teilnehmer:innen können es lesen und Branches hineinschieben. Jedes Rezept liegt dort in einem eigenen Ordner unter rezepte/.

Schritt 1: das Kochbuch klonen

  1. Öffne GitHub Desktop. Menü File, Clone Repository.
  2. Reiter GitHub.com, dann gitklar/kochbuch anklicken. Tippe kochbuch in das Suchfeld, wenn die Liste lang ist.
  3. Bei Local Path auf Choose klicken und Dokumente/gitrepos/gh-org-gitklar wählen.
  4. Klicke auf Clone. Oben links steht jetzt Current repository: kochbuch.

Schritt 2: einen Branch anlegen

Ein Branch ist deine eigene Arbeitslinie im Kochbuch. Auf ihm kannst du Dateien hinzufügen, ohne die Hauptfassung main anzufassen.

  1. Dein Ordner im Kochbuch heisst wie dein GitHub-Benutzername, in Kleinbuchstaben, zum Beispiel rezepte/dein-benutzername. Weil jeder Benutzername nur einmal vorkommt, kann kein Ordner doppelt angelegt werden.
  2. Klicke in GitHub Desktop oben in der Mitte auf Current branch, dann auf New branch.
  3. Schreib als Namen rezept- und deinen Benutzernamen, zum Beispiel rezept-dein-benutzername. Klicke auf Create branch.
  4. Oben steht jetzt Current branch: rezept-linsensuppe.

Screenshot folgt: GitHub Desktop: New branch. Das aufgeklappte Current branch mit dem Knopf New branch und das Fenster Create a branch mit dem Namen rezept-linsensuppe. Datei: bilder/desktop-neuer-branch.png.

Schritt 3: deinen Rezeptordner kopieren

Du kopierst den Ordner rezept aus deinem eigenen Repository in das Kochbuch. Dein eigenes Repository bleibt, wie es ist.

  1. Öffne im Finder Dokumente/gitrepos/gh-org-gitklar/rezept-dein-benutzername.
  2. Klicke einmal auf den Ordner rezept und drücke Befehl und C.
  3. Öffne Dokumente/gitrepos/gh-org-gitklar/kochbuch/rezepte und drücke Befehl und V. Jetzt liegt dort ein Ordner rezept.
  4. Klicke einmal auf den neuen Ordner, drücke die Eingabetaste und schreib deinen Benutzernamen in Kleinbuchstaben.
  1. Öffne im Explorer Dokumente\gitrepos\gh-org-gitklar\rezept-dein-benutzername.
  2. Klicke einmal auf den Ordner rezept und drücke Strg und C.
  3. Öffne Dokumente\gitrepos\gh-org-gitklar\kochbuch\rezepte und drücke Strg und V. Jetzt liegt dort ein Ordner rezept.
  4. Klicke einmal auf den neuen Ordner, drücke F2 und schreib deinen Benutzernamen in Kleinbuchstaben.

Im Ordner rezepte liegen jetzt _vorlage, die Ordner der anderen und dein neuer Ordner mit zutaten.csv und rezept.md.

Schritt 4: committen

  1. Wechsle zu GitHub Desktop. Im Reiter Changes stehen links deine neuen Dateien, zum Beispiel rezepte/dein-benutzername/rezept.md, jede mit einem Häkchen.
  2. Schreib unten links bei Summary eine Nachricht, zum Beispiel Rezept Linsensuppe hinzugefügt.
  3. Der Knopf darunter heisst jetzt Commit to rezept-linsensuppe, mit dem Namen deines Branches. Steht dort Commit to main, bist du auf dem falschen Branch. Geh dann zurück zu Schritt 2.
  4. Klicke auf den Knopf.

Schritt 5: den Branch veröffentlichen

Dein Branch existiert bis jetzt nur auf deinem Laptop. Klicke oben rechts auf Publish branch. GitHub Desktop schiebt den Branch mit deinem Commit nach GitHub.

Screenshot folgt: GitHub Desktop: Publish branch. Die Leiste oben mit Current branch: rezept-linsensuppe und dem Knopf Publish branch, darunter der Kasten mit Preview Pull Request. Datei: bilder/desktop-publish-branch.png.

Schritt 6: den Pull request öffnen

Ein Pull request ist deine Bitte, deinen Branch zu prüfen und in main zu übernehmen.

  1. GitHub Desktop zeigt nach dem Veröffentlichen einen Kasten mit dem Knopf Preview Pull Request oder Create Pull Request. Klicke darauf, und wenn nötig noch einmal auf Create pull request. Dein Browser öffnet sich auf github.com.
  2. Oben steht base: main und compare: rezept-linsensuppe. So soll es sein.
  3. Schreib als Titel den Namen deines Gerichts, zum Beispiel Linsensuppe.
  4. Im Textfeld darunter steht schon eine Vorlage. Ergänze bei Gericht den Namen und bei Ordner deinen Benutzernamen.
  5. Hake die Kästchen ab, die für dein Rezept stimmen. Im Textfeld setzt du dafür ein x zwischen die eckigen Klammern: aus - [ ] wird - [x]. Passt ein Kästchen nicht, lass es leer und schreib einen Satz dazu.
  6. Klicke auf Create pull request.

Screenshot folgt: github.com: der Pull request mit der Vorlage. Die Seite Open a pull request im Kochbuch mit base: main, compare: rezept-linsensuppe, dem Titel und der Vorlage mit den Kästchen. Datei: bilder/github-pr-vorlage.png.

Schritt 7: auf das Review warten

Ich oder eine andere Person aus dem Kurs liest deinen Pull request. Das heisst Review. Kommentare kommen bei dir als E-Mail von GitHub an.

  • Alles passt. Dann wird dein Pull request gemergt, und dein Rezept steht im Kochbuch.
  • Jemand bittet um eine Änderung. Ändere die Datei auf deinem Laptop im Ordner kochbuch, auf demselben Branch. Committe und klicke auf Push origin. Der offene Pull request zeigt den neuen Commit von selbst. Einen neuen Pull request brauchst du nicht.

Merge deinen Pull request nicht selbst, auch wenn GitHub dir den Knopf anzeigt. Das Lesen durch eine zweite Person ist der Sinn der Übung.

Geschafft, wenn

Auf github.com/gitklar/kochbuch/pulls dein Pull request mit dem Namen deines Gerichts steht, mit deinen Dateien im Reiter Files changed und abgehakten Kästchen.

Hängt es?

  • Commit auf main statt auf deinem Branch. Solange du noch nicht gepusht hast, zeigt GitHub Desktop unten links unter dem Commit den Knopf Undo. Klicke darauf. Deine Dateien sind wieder ungespeicherte Änderungen. Leg dann den Branch an (Schritt 2). GitHub Desktop fragt, ob die Änderungen mitkommen sollen. Wähle, dass sie auf den neuen Branch mitkommen. Hast du schon gepusht, schreib mir.
  • Im Reiter Changes erscheint nichts. Der Ordner liegt an einem anderen Ort. Er gehört nach kochbuch/rezepte. Prüfe den Pfad.
  • Der Ordner heisst noch rezept. Benenne ihn um, wie in Schritt 3. GitHub Desktop zeigt die Änderung als neue Dateien an.
  • Publish branch fehlt, oben steht Push origin. Der Branch ist schon veröffentlicht. Klicke auf Push origin, falls Commits fehlen, und mach mit Schritt 6 weiter.
  • Alles andere: Kommentar in dein Issue im Repository gitklar/vorbereitung, mit Screenshot.