Developer_3.x Guidelines

Guidelines

Allgemein

• Arbeit in GIT nach dem Forking Workflow
• Einhaltung der Coding Guidelines
• Zu entwickelnde Features sollten als Issue vor dem Pull-Request bekannt gemacht werden
• Fork Branch Hinweise:
  • Jeder Branch sollte in sich geschlossen sein und nur genau die Änderungen beinhalten, die nötig sind
  • Können zum Bearbeiten eines Features entweder in privaten, persönlichen Forks oder in einem Fork einer GitHub-Organisation durch mehrere Personen durchgeführt werden

Commits

• In englischer Sprache, Orientierung an bspw. http://chris.beams.io/posts/git-commit/
• Commits sollten nur die Änderungen enthalten, die auch in der Commit Nachricht beschrieben sind
• Eher viele kleine Commits mit jeweils wenigen Änderungen als wenige, große / umfangreiche Commits

Pull-Requests

• sollten idealerweise von einer anderen Person als dem Ersteller auf GitHub begutachtet (review changes) werden.
• müssen zum Zeitpunkt des Merges fehlerfrei integrierbar sein. Konflikte müssen vom Ersteller gelöst werden.

Branch Unterscheidung

• Branch main: Hier findet die Haupt-Entwicklung inklusive neuer Features, Bugfixes, ... statt
• Branch X.Y.x: Hier findet die Wartung einer Major-Minor Release Version statt. Bspw. in 4.0.x die Wartung und neue Releases der Version 4.0.x Versionen (bspw. 4.0.1, 4.0.2, ...)