Zum Inhalt

Versionierung und Policy

Versionierung

Die Inhaltsdateien werden mit Git versioniert, zu dem an dieser Stelle aber keine Einführung gegeben wird. Wenn Sie hiermit ein Problem haben, melden Sie sich bitte, damit wir eine praktikable Lösung finden. Wichtig sind jedoch einige Hinweise.

Rollen

Für das Repository auf dem Git-Server existieren verschiedene Rollen mit unterschiedlichen Rechten:

  • Administratoren (dürfen alles)
  • Editoren (dürfen Pull Requests mergen, aber nicht direkt auf master pushen)
  • Mitwirkende (Contributors) (dürfen nicht auf master pushen, müssen Pull Requests öffnen)

Das bedeutet in erster Linie, dass alle Mitwirkenden (außer Administratoren) grundsätzlich im Kontext von Zweigen (Git Branches) arbeiten müssen und ihre Änderungen in Pull Requests1 zur Diskussion stellen müssen.

Falls Sie noch keine Erfahrung mit solchen Workflows haben sollten, beachten Sie bitte, dass das zwar auf den ersten Blick vielleicht etwas kompliziert erscheinen mag, Ihnen letztlich aber das Leben signifikant erleichtert. So ist es erfahrungsgemäß leichter, Texte und Anleitungen in dem Wissen zu schreiben, dass vor der endgültigen Integration noch das Sicherheitsnetz des »Review« steht.

Formatierung

Die folgenden Richtlinien sind keine ganz harten Kriterien, sollten aber nach Möglichkeit beachtet werden.

Zeilenlänge

Wenn Sie über einen Texteditor verfügen, der das automatische Einfügen von Zeilenumbrüchen unterstützt, begrenzen Sie die Zeilen bitte auf ca. 80 Zeichen.2

Whitespace

Wenn Ihr Editor dies unterstützt, aktivieren Sie bitte eine Funktion, die Leerzeichen am Zeilenende beim Speichern automatisch entfernt.3

Commits

Commits sollten eher zu häufig als zu selten erfolgen. Bitte committen Sie engmaschig und v.a. möglichst zusammenhängende Änderungen.

Bitte bemühen Sie sich um aussagekräftige Titelzeilen der Commit Message (<= 50 Zeichen) sowie ggfs. ausreichender Beschreibungen im Body der Commit Message (mit harten Zeilenumbrüchen nach 80 Zeichen).

  1. Die Git-Anleitungen auf GitHub sind in aller Regel sehr gut und anschaulich geschrieben. Beachten Sie aber bitte, dass sie zwar die Grundlagen von Git erläutern, dies aber immer im Kontext einer speziellen Anbieterplattform (GitHub) tun. Gitea, die auf dem Hochschulserver installierte Git-Projektmanagementplattform, ist GitHub zwar sehr ähnlich, im Detail jedoch nicht identisch. ↩

  2. Markdown ignoriert (wie auch HTML) einfache Zeilenumbrüche, daher kann man mit diesen die Quelldateien »gestalten«. Eine Begrenzung auf 80 Zeichen macht die Dateien aber in vielen Kontexten (etwa auf dem Git-Server) leichter lesbar. Darüber hinaus können Veränderungen in der Git-History zielgenauer verfolgt und die Beiträge entsprechend ihrem Umfang gewürdigt werden. ↩

  3. Sowohl die Berücksichtigung der Zeilenlänge als auch der Leerzeichen am Zeilenende erhöhen die Chance, dass Ihre Beiträge unverändert ins Repository übernommen werden. Beachten Sie, dass Zeilen, die lediglich aus formalen Gründen verändert wurden, in der Statistik letztlich einem anderen Autor zugeschrieben werden ;-) ↩

Letztes Update: 9. März 2020