Skip to content

Git Workflow

Jump to bottom
Patrick Petrovic edited this page Jun 2, 2017 · 4 revisions

Bei Git ist es wichtig, dass wir alle das gleiche tun, um Chaos zu vermeiden. Bitte daran denken und bei Bedarf einfach nochmal hier reinschauen!

Setup

Unter Windows lädst du dir Git hier herunter und befolgst die Anweisungen. Unter macOS oder Linux musst du nichts tun.

Nun führst du folgendes aus: git clone https://github.com/ppati000/PSE. Danach hast du in deinem aktuellen Directory den neuen Ordner PSE. Fertig!

Commit messages

Beim Pflichtenheft haben wir uns geeinigt, diese auf Deutsch zu schreiben, da das Dokument auch auf Deutsch ist. Bitte konventionell im Präsens ("Füge Kann-Kriterien hinzu" und nicht "Kann-Kriterien hinzugefügt"). Außerdem natürlich auf aussagekräftige Messages achten. (etwas wie "awsdadwadsaw" unbedingt vermeiden 🙂)

Gitignore und Newlines

Bei Bedarf bitte Files und Directories in die .gitignore eintragen. Dazu zählen Sachen wie .idea, .settings, desktop.ini und andere Dateien, die nicht zum Code gehören. Außerdem immer Windows Newlines (CRLF) verwenden 🙂

Am Ende jeder Datei sollte eine leere Zeile sein, sonst meckert GitHub rum.

Workflow

Wenn du Änderungen machst, sollte das immer wie folgt ablaufen:

  1. Du wechselst auf eine neue Branch mit git checkout -b xx/<branch name>. Dabei steht für xx für deine Initialen oder irgendeine Buchstabenkombination, die sich nicht ändert und die dich erkennbar macht.

  2. Du schreibst die minimale Menge an Code, die nötig ist, damit deine Änderung vollständig ist. (Bitte keine riesigen commits, wenn nicht absolut notwendig)

  3. Mit deinem IDE deine Änderungen nochmal prüfen. (In IntelliJ: Rechtsklick auf base directory -> Git -> Commit Directory... -> Diff Button oben links. Optional kann man danach direkt über das GUI committen. Ansonsten:)

  4. git add -A

  5. git commit -m "Add new feature x"

  6. git push --set-upstream origin xx/<branch name>

  7. Auf die Repo Frontpage gehen und ein Pull Request erstellen

  8. Auf mindestens 1 Code Review Approval warten

  9. Ggf. Änderungen nach Code Review vornehmen, sonst weiter zu 14

  10. Punkt 3 nochmal durchführen

  11. git add -A

  12. git commit --amend (Um nicht 2 commits im PR zu haben)

  13. git push --force (Achtung, aufpassen mit force. Das überschreibt deine Remote Branch.)

  14. Nach Approval: Auf GitHub kleines Dreieck rechts neben dem großen Merge Button, dann auf Rebase and merge. Fertig!

Wie ich Änderungen von GitHub auf auf meinen PC bekomme

Fall 1: Aktuell im master

Dann einfach git pull.

Fall 2: Aktuell in einer Feature Branch mit neuen Änderungen

  1. Alle Änderungen committen (gegebenenfalls mit --amend, falls schon ein neuer Commit existiert in deiner Branch)
  2. git checkout master
  3. git pull
  4. git checkout <Name der Feature Branch>
  5. git rebase -i master
  6. Den erscheinenden Texteditor schließen (je nach OS unterschiedlich)
  7. Luft anhalten
  8. Falls Merge Conflict, diesen lösen (am besten mit einem Tool) und dann git rebase --continue. Ansonsten fertig.

Clone this wiki locally