Was ist GIt?
Git ist ein verteiltes Versionskontrollsystem. Es wurde entwickelt um Quellcode und andere Dateien effizient zu verwalten bei uns ist es da um Dokumentation und unseren Quellcode für das Projekt zu Versionieren. Git verfolgt alle Änderungen an Dateien, sodass wir jederzeit zzu alten Versionen und früheren Ständen ohne Probleme zurückkehren können und Änderungen nachverfolgen können.
Git Repositories:
Git Issues:
Git Issues sind digitale Notizzettel oder To-Do-Punkte innerhalb eines Projektes. Wir verwenden Issues um neue Aufgaben für uns zuzuteilen. Um auf Fehler und Bugs hinzuweisen die gefixed gehören.Sie sind dafür da um zu wissen was bis zu unserem nächsten Meeting erledigt sein soll
Was soll in einem Issue drin stehen?
Titel(In dem soll kurz stehen was zu tun ist),
Beschreibung(Hier soll stehen was wirklich gemacht werden soll entweder in Form von Text als erklärung oder mithilfe eines Ausschnittes vom Code an der stelle an der er bearbeitet werden soll)
Kommentare(Sind zur Diskussion im Team da)
Labels(Um die Priorität des Issues zu markieren und um welche Art von Arbeit es sich handelt also zum Beispiel Frontend oder Backend)
Zuweisung(Die Aufgabe soll einer Person zugewiesen werden entweder man weißt sich selbst darauf zu oder wenn anderen)
Meilenstein(Um zu wissen in welchen Projekt abschnitt sich dieses Issue befindet
Typischer Ablauf eines Issues bzw. wann erstellen wir ein Issue?
Erstellen: Wir erstellen ein Issue wenn jemand feststellt das etwas getan werden muss oder irgendwo ein Fehler vorliegt. Wir machen uns in unseren Meetings aus was zu tun ist und wer was macht. Hier können wir auch Fragen klären oder Lösungs ansätze vorschlagen. Außerdem ist es notwendig das das Issue einer Person zugewiesen wird
Wenn man die Aufgabe erledigt hat, wird das Issue geschlossen
Ein kurzes Beispiel wie man ein Issue erstellt: Du gehst auf unseren Git Server zum Projekt -> klickst auf „Issues“ -> „New Issue“.
Du gibst Titel & Beschreibung ein -> z. B. „ Titel: Git Dokumentation ist zu machen“.
Du weist es dir oder jemand anderem zu.
An der Aufgabe wird gearbeitet
Wenn sie fertig ist schließt du das Issue.
Commits:
Jede Änderung am Source Code wird mit einem Commit in das Versionierungssystem (Git / Gitea) aufgenommen. Ein Commit besteht aus seinen Änderungen, seinem Titel. Ein Commit soll relativ klein Gehalten werden und bis zu (ca.) 10 veränderte Datein beinhalten. Der Titel muss Aussagekräftig sein. Man kann bestimmte Key-Words in den Commit Titel mit einbringen.
Anforderungen an eine gute Commit Message:
fasst die Begründung / den Kontext der Änderungen kurz zusammen maximale Zeilen Länge von von etwa 50 Zeichen (bei mehrzeiligen Nachrichtigen:) eine Leerzeile nach der ersten Zeile. Der erste Buchstabe der ersten Zeile wird groß geschrieben Kein Satzzeichen am Ende der ersten Zeile Die erste Zeile wird Imperativ formuliert ausschließlich auf Englisch