Pull Requests

Ein pull request ist eine Bitte, eine Reihe von Änderungen einzuspielen. Die Arbeitsweise läuft meist wie folgt:

1. Entwickler forkt das Repository
2. Entwickler erstellt einen separaten branch, dessen Name das Problem beschreibt. Wenn ein Problem in foo in der bar-Komponente gelöst wird, dann z.B. mit git branch fix-foo-bar. Für ganz einfache Änderungen braucht ihr das nicht unbedingt. Wer bereits erstellte commits umändern will, muss etwas tricksen.
3. Entwickler korrigiert Probleme / schreibt Erweiterungen. Dabei kann man ruhig mehrere Commits erstellen. Optimal ist, wenn jeder Commit eine kleinere Änderung ist, z.B.
   • lasse foo weiterlaufen, falls bar ausfällt
   • Unittest für Fehler in foo.bar
   • Korrigiere bar-Komponente in foo
   • Aktualisiere Dokumentation von foo.bar für häufige Fehlerursachen
4. Entwickler pusht seine Änderungen zum eigenen Repository.
5. Entwickler klickt auf den Pull Request-Button und gibt eine Nachricht ein.

Maintainer schaut sich die Änderungen, verlangt ggf. Verbesserungen
Maintainer spielt die Änderungen in die Software ein.

Mehr zu pull requests auf github.

pull request-Nachricht

Die Nachricht eines pull-Requests sollte aus folgenden Informationen bestehen:

1. Eine Zusammenführung (1 Satz), was der pull request macht ('Korrigiere foo.bar, wenn baz passiert'). Der Titel ist eine Kurzform davon (Korrigiere foo.bar).
2. Wenn möglich einen Verweis auf das issue. Am besten einfach indem man (closes #42) an den Titel anhängt.
3. Eine kurze Beschreibung, wie das Problem diagnostiziert wurde, oder wofür das Feature nützlich ist, etwa Wenn baz in einer Vollmondnacht gilt und foo zwei Anfragen kurz hintereinander bekommt, wird in foo.bar der Zugriff nicht
richtig serialisiert.

So nicht:

Geänderte Dateien: foo/bar.h, foo/bar.c / foo/bar/README, foo/components.c, foo/util.h

Diese Information wird automatisch generiert. Klickt einfach auf diff, um sie selber zu sehen.

Titel: Issue #42
Text: #42

Der pull request sollte allein aussagekräftig sein.

Titel: Die bar-Komponente in foo ist manchmal fehlerhaft. Dieser pull request fix...
Text: ...t sie, wenn baz eintritt.

Titel und Text müssen alleine aussagekräftig sein. Nicht jeder liest sie zusammen.

Titel: Korrigiere bar-Komponente
Text: Dieser pull request korrigiert foo.bar, wenn baz passiert.
      Außerdem wird der bug #42 (Fehler beim Aufbauen der Netzwerkverbindung) gelöst
      Weiterhin wird in der xy-Komponente jetzt facebook unterstützt

Ein pull Request sollte ein Thema haben. Erstelle mehrere Branches (mit [code]git checkout -b[/code]) für mehrere Änderungen.