Git(Hub)

[sventhiel]

Because most of our source code is part of public repositories on GitHub, it might be worth to get familiar with Git.

Tasks

• [x] setup proper Git environment

Questions

• [x] What is Git and how do I use it? (pull, push, merge, ...)
• [x] What are the general rules for using Git within our group?

https://youtube.com/playlist?list=PL58qjcU5nk8s-UQHfzeVajBDwkbWqwSc6&si=j5LdCmPld_oJA9A0

[TitoPrausee]

1. Branching-Strategie:

   • Definiere eine Branching-Strategie, die zu deinem Projekt passt. Gängige Strategien sind Gitflow, Feature-Branching oder trunkbasierte Entwicklung.

2. Repository-Struktur:

   • Halte die Repository-Struktur organisiert und logisch. Gruppiere zusammengehörige Dateien und Verzeichnisse.

3. Commit-Richtlinien:

   • Verfasse klare und beschreibende Commit-Nachrichten. Enthalte Informationen darüber, was geändert wurde und warum. Verwende den Imperativ (z. B. "Bug beheben" anstelle von "Bug behoben").
   • Mache kleinere, fokussierte Commits anstelle von großen, monolithischen.

4. Pull Requests (PRs):

   • Verwende Pull Requests (oder Merge Requests) für Code-Reviews. Verlange Code-Reviews vor dem Zusammenführen.
   • Ermutige zu Diskussionen und Feedback in den PRs, um die Code-Qualität sicherzustellen.

5. Code-Review:

   • Reviewer sollten konstruktives Feedback geben und nach Code-Qualität, Korrektheit und Einhaltung von Codierungsstandards suchen.
   • Verwende Code-Linter und automatisierte Testtools, um gängige Probleme vor Code-Reviews zu erkennen.

6. Mergen:

   • Stelle Regeln für das Zusammenführen von Code auf. Einige gängige Optionen sind Fast-Forward-Merges, Squash-Merges oder Merge-Commits.
   • Stelle sicher, dass der Code in einem Branch getestet und überprüft wird, bevor er in den Hauptbranch gemerged wird.

7. Continuous Integration (CI):

   • Richte CI/CD-Pipelines ein, um Tests und Bereitstellungsprozesse zu automatisieren. CI kann dazu beitragen, Probleme frühzeitig zu erkennen und die Code-Qualität zu erhalten.

8. Git Hooks:

   • Erwäge die Verwendung von Git Hooks für Aufgaben wie Vor-Commit-Prüfungen oder benutzerdefinierte Validierungsskripte.

9. Dokumentation:

   • Pflege klare und aktuelle Dokumentation darüber, wie dein Team Git verwendet. Enthalte Richtlinien für gängige Git-Aufgaben und Arbeitsabläufe.

10. Konfliktlösung:

    • Schulung der Teammitglieder zur effektiven Lösung von Merge-Konflikten.

11. Git-Etikette:

    • Fördere eine gute Git-Etikette, wie das Vermeiden von Force-Pushs in gemeinsame Branches und das Sauberhalten der Commit-Historie.

12. Gitignore:

    • Verwende eine .gitignore-Datei, um Dateien und Verzeichnisse anzugeben, die von Git nicht verfolgt werden sollten (z. B. Build-Artefakte, editor-spezifische Dateien).

13. Sicherheit:

    • Achte auf Sicherheit. Vermeide das Commiten sensibler Informationen wie Passwörter oder API-Schlüssel in Repositories.

14. Kommunikation:

    • Fördere offene Kommunikation im Team, um Git-bezogene Probleme oder Fragen zu besprechen und zu lösen.