Projekt Guideline

Allgemeines

Hier beschrieben ist eine Anleitung für alle Projektmitglieder für das Beitragen zu diesem Projekt. Es ist sehr wichtig, dass alle Projektmitglieder sowohl das Projektmanagement, als auch die Struktur dieses Projektes verstehen, damit wir gemeinsam effektiv daran arbeiten können.

Projektmitglieder

• Frontend - Luis ➡️ Profil
• Frontend - Justin ➡️ Profil
• Backend - Ingo ➡️ Profil
• Backend - Henry ➡️ Profil
• Projektmanagement - Benedict ➡️ Profil

Projektmanagement

Das Projekt gliedert sich in folgende Teile:

• Das Repository G5-DuoGradus enthält den gesamten Source Code für die Applikation. Es ist im Wesentlichen in drei Teile unterteilt
  • frontend beinhaltet den Frontend Code
  • backend beinhaltet den Backend Code
  • docs beinhaltet die gesamte Dokumentation des Projektes und ist auf docs.duo-gradus.de öffentlich zur Verfügung gestellt
• Die Issues des Repositories werden verwendet um Tasks aufzuteilen, Bugs festzuhalten und (in der Zukunft) Feature Requests zu verwirklichen
• Die Pull requests werden verwendet um größere Änderungen Issues zuzuordnen und gemeinsam über diese Änderungen zu diskutieren
• Die Discussions werden genutzt um Anforderungen festzuhalten, über sie abzustimmen und über sie zu diskutieren
• Die DuoGradus Anwendung wird unter staging.duo-gradus.de für Testzwecke zur Verfügung gestellt, zur Anmeldung müssen Benutzername und Passwort leer gelassen werden

Das Projektmanagement wird zudem über ein Github Project ergänzt.

Github Project

Das Github Project gliedert sich in die folgenden drei zentralen Ansichten

Backlog

Der Backlog (siehe https://en.wikipedia.org/wiki/Product_backlog) wird verwendet um die Tasks (in Form von Issues) übersichtlich darzustellen und zu managen. Alle zu erledigenden Aufgaben im Projekt werden als Issue im Backlog erfasst.

Timeline

Die Timeline zeigt den Backlog auf einer Zeitachse nach ihrer Iteration. Iterationen leiten sich aus den Anforderungen der Vorlesung ab, wobei wir unsere Aufgaben anhand von Wochen darstellen sollen. Eine Iteration stellt hier also eine Woche dar.

Aufgabenstatus

Der Aufgabenstatus zeigt ein Kanban Board mit dem Backlog. Es gibt die Kategorien Todo, In Progress und Done. Das den Task bearbeitende Gruppenmitglied ist dafür verantwortlich, dass sich sein Task immer in der korrekten Kategorie befindet.

Sonstige

Hinzu kommen noch die folgenden 2 unterstützenden Ansichten:

• Backlog nach Komponente
• Backlog nach Iteration

welche jeweils den Backlog verschieden gegliedert darstellen.

Verwendete (gesprochene) Sprachen

Um das Projekt einheitlich zu halten und Diskussionen möglichst zu vereinfachen besteht die folgende Guideline für gesprochene Sprachen.

• Code wird komplett auf Englisch geschrieben, auch die direkt im Code enthaltene Dokumentation wie z.B. Kommentare oder Beispiele
• Discussions und Issues werden auf Deutsch verfasst
• Pull Requests werden auf Englisch verfasst, da sie oftmals sehr verwachsen mit dem Code sind
• README sowie Docs werden auf Deutsch verfasst, da die "Zielgruppe" (Vorlesung an der Hochschule) Deutsch spricht
• Commit Messages sind egal da nur noch Squash Merges möglich sind und somit nur der Titel des Pull Requests erscheint
• Das User Interface der Demo App wird auf Deutsch geschrieben

---

Die Inspiration für eine Project Guideline ist von Gruppe 4