Fertig
Git
Repository klonen
Als erstes muss das Repository mit SourceTree geklont werden. Der Weg des direkten Klonens aus Atom heraus ist noch zu erforschen.
Branches
In Atom wird unten rechts die Schaltfläche Git angezeigt. Diese öffnet den git-Tab. Links daneben ist die Schaltfläche GitHub, die hier unwichtig ist. Links daneben ist die Schaltfläche Fetch, mit der die lokalen Dateien mit dem Repository abgeglichen werden.
Links daneben steht der Branch, in dem gerade gearbeitet wird. Mit einem Links-Klick auf den Branch wird zwischen den Branches gewechselt. Die Branches werden automatisch beim Erstellen eines Merge-Requests (siehe nächsten Abschnitt) angelegt.
Bearbeiten eines Issues
Es werden zwei Arten von Änderungen unterschieden - die, die direkt in den develop-Branch gepusht werden, und die, die ein Issue in Git voraussetzen.
Das Pushen in den develop sollte die Ausnahme sein und nur kleine Änderungen betreffen, wie Rechschreibfehler oder Seitenfehler, z.B. ein falsch verknüpftes Bild.
Die meisten Änderungen beginnen mit einem Issue, das in Git angelegt wurde.
Zwischen der Beschreibung und den Kommentaren befindet sich der Button Create merge request. Ein Klick auf diesen Button erstellt einen neuen Branch mit dem Namen des Issues (in diesem Beispiel 43-test-issue) und erstellt außerdem einen Merge-Request (im Weiteren Merge). Des Weiteren ist der Ersteller des Merges als participant zugeordnet. Somit ist nachvollziehbar, wer den Merge erstellt hat und somit an dem Issue arbeitet.
Der neue Branch muss erst geholt werden. Das erfolgt am besten in SourceTree. Dort unter REMOTES - origin mit der rechten Maustaste auf den Branch und z.B. origin/43-test-issue holen… klicken.
Danach auf OK klicken.
Der Branch ist jetzt in Atom auswählbar.
Nach dem Branchwechsel wird also in einer Kopie des develop gearbeitet. Jeder Arbeitsschritt kann jederzeit gepusht werden und verändert nichts am develop und wird auch nicht veröffentlicht.
Nach jedem Push läuft eine Pipeline, die eine Seite mit den Änderungen erstellt (welche in Zukunft genutzt werden könnte, um die Änderungen zu überprüfen).
Ist die Pipeline erfolgreich durchlaufen, muss der Merge als Ready markiert werden.
Danach sollte im Kommentar derjenige direkt angesprochen werden, der Korrektur lesen soll. Das könnte wie folgt aussehen:
@fstarke Bitte Korrektur lesen und wenn OK mergen.
Notiz: Eine Alternative für die erste Korrektur-Anfrage ist das Hinzufügen der entsprechenden Person in der Auswahl Reviewers rechts am Rand. Über Edit kann die Person eingetippt und/oder angeklickt werden. Das Hinzufügen als Reviewer schickt automatisch eine Benachrichtigung an diese Person.
Sollten Änderungen erforderlich sein, sind diese als Kommentar zu vermerken und der Autor ist am besten noch zu erwähnen:
@mgut Folgender Fehler muss noch korrigiert werden: Z. 65: Lorem ipsum dolor sit amet, consectetur adipisicing…
Notiz: Unter Changes (direkt unterhalb des Merge-request-Titels) kann explizit auf die einzelnen Änderungen des Merge-requests Bezug genommen werden. Hierüber getätigte Kommentare erscheinen im Overview mit einem Auszug der betroffenen Code-Zeilen.
Nach der Korrektur muss wieder ein Kommentar folgen, wie z.B.:
@fstarke Ist korrigiert, bitte mergen.
Wenn keine Änderungen mehr erforderlich sind, kann danach der Merge vom Korrektur-Lesenden durch Klick auf den Button Merge mit dem develop vermengt werden.
Danach läuft wieder eine Pipeline, die die beiden Branches (develop und z.B. 43-test-issue) vermengt und veröffentlicht.
Wenn alles ohne Probleme durchgelaufen ist, sind zwei grüne Häkchen zu sehen.
Hinweis: Bis die Änderungen unter handbuch.buchner.io zu sehen sind, vergehen bis zu 60 Minuten!
Nachdem die Änderungen unter handbuch.buchner.io zu sehen sind, kann der Branch (in diesem Fall 43-test-issue) gelöscht werden. Die gemergeten Branches werden nicht automatisch gelöscht und sind sowohl lokal als auch auf dem Server vorhanden und können in Zukunft zu Verwirrung führen. Ansonsten stören sie nicht weiter.
Das Löschen sollte am besten in SourceTree erfolgen. Um lokale Branches löschen zu können, darf der zu löschende Branch nicht ausgewählt sein. Am besten wird zuerst der develop durch Doppelklick ausgewählt. Danach mit rechter Maustaste auf z.B. den Branch 43-test-issue klicken und dann Lösche 43-test-issue auswählen.
Als letztes sollte noch der Branch vom Server gelöscht werden. Dazu mit rechter Maustaste auf REMOTES - origin - 43-test-issue und dann Lösche origin/43-test-issue auswählen.
Hinweis: Eine Commit-Message darf nicht mit einem # beginnen.
Warnung: Das Löschen von Branches sollte nur jemand machen, der genau weiß, was zu tun ist.