Contribution Guide
Herzlich willkommen auf der Wiki-Seite für den Contribution Guide unseres Projekts. Hier finden Sie eine Anleitung für Entwickler, die beschreibt, wie Sie die App nach dem Klonen des Repositorys starten können, welche Informationen ein Pull-Request enthalten muss, welche Branches es gibt, ob es ein Versions- und Releasemanagement gibt und ob es Code-Analyse-Tools oder eine CI-Pipeline gibt. Folgen Sie diesen Anweisungen, um sicherzustellen, dass Ihr Beitrag zum Projekt reibungslos verläuft. Darüber hinaus eine Beschreibung des Git-Workflows und des verwendeten Code-Styles.
Clonen des Repos: git clone [email protected]:rsfr10/wild-vinland.git
Git LFS initiieren für Assets: git lfs install
Es wird sich an die von Microsoft herausgegebene Coding Conventions für C# gehalten.
Wir empfehlen die Nutzung von GitHub Desktop.
Die Branches unseres Projektes werden wie folgt verwaltet:
- Master-Branch: Dieser Branch enthält unseren aktuellen, funktionierenden Stand.
- Für jede User-Story/Task sowie jeden Bug wird ein eigener Branch erstellt. Nach dem Abschluss eines Task / eines Bugfixes wird ein Merge-Request an den Master-Branch gestellt. Der Merge-Request wird dann von jemanden aus der Gruppe reviewet, der nicht am Task beteiligt war. Es wird versucht, dass jeweils nur eine Person an einem Branch arbeitet. Name des Branches und des Merge-Request soll mit der Bezeichnung in YouTrack übereinstimmen.
kurze Git-Branch-Befehlsübersicht
Zu Beginn einer neuen Featureentwicklung:
git fetch
git checkout <branchname>
git rebase origin/main
//gegebenenfalls Konflikte manuell beseitigen
//dann fortsetzen mit git rebase --continue
Zum Ende einer neuen Featureentwicklung:
git fetch
git checkout <branchname>
git rebase origin/main
//gegebenenfalls Konflikte manuell beseitigen
//dann fortsetzen mit git rebase --continue
git push origin <branchname>
//Wichtig: Erst nach endgültigem Abschluss pushen, sonst gibt es Probleme mit git rebase
//Sonst kann dieses nicht verwendet werden.
Merge-Request erstellen
*in Teilen inspiriert von https://wiki.thm.de/SWT-P_SS_2016_Augmented_Reality(1)
