Wiki source code of GitLab Erklärungen

Version 78.2 by Pascal Meyer on 2025/08/15 00:21

Show last authors
1 {{toc/}}
2
3 Ab dem Wintersemester 2025/2026 wird die Projektstrukturierung und der [[Scrum>>doc:Main.Scrum.WebHome]]-Prozess in GitLab durchgeführt. Für die wichtigsten, grundlegendsten Funktion gibt es nachfolgend als Einstiegshilfe einige Erklärungen.
4
5 = Issue/Task-Erstellung in GitLab =
6
7 Für die Erstellung von Issues (User-Stories) oder Tasks (Aufgaben) wird in der Projektnavigationsleiste der Reiter** "Issues" **angeklickt und nachfolgend die Option **"New issue"** ausgewählt.
8
9 [[image:Issue1.png||data-xwiki-image-style-border="true"]]
10
11 Anschließend öffnet sich ein neues Fenster mit vielen Option. Hierbei kann ein Typ, ein Titel, eine Beschreibung und viele weitere unterschiedlichen Funktionen festgelegt werden.
12
13 Als **"Type" **stehen drei Optionen zur Auswahl:
14
15 * "Incident" - Ein Zwischenfall/Störung
16 * "Issue" - Im SWP eine User-Story (siehe [[User-Stories>>doc:Main.Scrum.WebHome||anchor="HUserStories"]])
17 * "Task" - Eine Aufgabe
18
19 Im unten gezeigtem Beispiel wird ein Issue gewählt und mit einem Titel (Name der User-Story) und einer Beschreibung (Akzeptanzkriterien) versehen.
20
21 Zusätzlich ist es möglich den Status (bspw. "To do", "Done", "In progress" etc), den Bearbeiter (ein oder mehrere Gruppenmitglieder), ein oder mehrere Labels, einen Meilenstein (siehe: ), Schätzungen und viele weitere Funktionen einzustellen. Anschließend werden die Angaben mit dem **"Create issue"** Button bestätigt.
22
23 [[image:Issue2.png||data-xwiki-image-style-border="true"]]
24
25 Es besteht im Anschluss direkt die Option sogenannte **"Child items"** hinzuzufügen. Dies ist besonders sinnvoll wenn die User-Story relativ umfangreich ist und somit besser in kleinere Arbeitspakete (bzw. Aufgaben) zerteilt werden sollte. Hierfür wird der **"Add"**-Button und entweder **"New task"** oder **"Existing task"** ausgewählt. Somit können entweder neue Aufgaben formuliert (wie im kommenden Beispiel) oder bestehende hinzugefügt werden.
26
27 [[image:Issue3.png||data-xwiki-image-style-border="true"]]
28
29 Hier wurde als Aufgabe das Feld für die Eingabe definiert. Anschließend wurde die Eingabe mit **"Create task"** bestätigt.
30
31 [[image:Issue4.png||data-xwiki-image-style-border="true"]]
32
33 Nachdem alle Informationen eingepflegt und ausführlich beschrieben wurden, ist das Issue vorerst fertig.
34
35 [[image:Issue5.png||data-xwiki-image-style-border="true"]]
36
37 == Status bei Issues ==
38
39 In GitLab werden standardmäßig fünf verschiedene Statusformen angeboten. Diese Optionen sind:
40
41 * **To do** (wird bei der Issue Erstellung standardmäßig ausgewählt)
42 * **In progress**
43 * **Done**
44 * **Won't do**
45 * **Duplicate**
46
47 Diese Statusformen werden genutzt um eine Sortierung und/oder Priorisierung der Issues zu ermöglichen. Zusätzlich dienen diese aber auch als Orientierung für das gesamte Projektteam. Somit weiß jedes Gruppenmitglied was erledigt ist und was noch erledigt werden muss.
48
49 [[image:Issue Status 1.png||data-xwiki-image-style-border="true"]]
50
51 Zur Status Änderung wird einfach die **"Edit"**-Option betätigt und anschließend öffnet sich ein Optionsmenü. Die gewünschte Option muss nur noch bestätigt werden und der neue Status wird festgelegt.
52
53 [[image:Issue Status 2.png||data-xwiki-image-style-border="true"]]
54
55 [[image:Issue Status 3.png||data-xwiki-image-style-border="true"]]
56
57 == Meilensteine und Epics ==
58
59 Im Laufe des Softwareprojektes werden eine Menge an Issues erstellt. Damit der Überblick, über die Vielzahl an Issues, nicht verloren geht wird im Softwareprojekt mit Meilensteinen (siehe [[Meilensteine>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:DievordefiniertenMeilensteine"]]) und Epics gearbeitet. In GitLab werden beide Funktionen mit **"Labels"** umgesetzt. Diese Option ist im Reiter "Manage" und anschließend unter "Labels" vorzufinden.
60
61 [[image:Label 1.png||data-xwiki-image-style-border="true"]]
62
63 [[image:Label 2.png||data-xwiki-image-style-border="true"]]
64
65 [[image:Label 3.png||data-xwiki-image-style-border="true"]]
66
67 Die Erstellung von Epics sind kongruent zur Erstellung der Meilensteine-Label**. **Zur Veranschaulichung wird das Epic-Label **"Lobby" **erstellt.
68
69 [[image:Epic1.png||data-xwiki-image-style-border="true"]]
70
71 [[image:Epic2.png||data-xwiki-image-style-border="true"]]
72
73 [[image:Epic3.png||data-xwiki-image-style-border="true"]]
74
75 Bei der Issue-Erstellung/Bearbeitung können die erstellten Labels jetzt mit den neuen/bestehenden Issues verknüpft werden. Dies erfolgt trivial zur Status-Option.
76
77 [[image:Issue Label 2.png||data-xwiki-image-style-border="true"]]
78
79 [[image:Label 4.png||data-xwiki-image-style-border="true"]]
80
81 [[image:Issue Label 3.png||data-xwiki-image-style-border="true"]]
82
83 = Product-Backlog =
84
85 Die erstellten Issues werden automatisch nach der Erstellung dem Product-Backlog (siehe [[Product-Backlog>>doc:Main.Scrum.WebHome||anchor="HProductBacklog"]]) hinzugefügt. Der Product-Backlog ist eine Liste mit allen erstellten und unbearbeiteten Issues. Dieser ist im GitLab unter dem Reiter **"Issue boards" **vorzufinden.
86
87 [[image:ProductBacklog1.png||data-xwiki-image-style-border="true"]]
88
89 [[image:ProductBacklog2.png||data-xwiki-image-style-border="true"]]
90
91 == Pflege/Priorisierung des Product-Backlogs ==
92
93 Die Pflege des Product-Backlogs (siehe [[Pflege>>doc:Main.Scrum.WebHome||anchor="HDerNutzeneinesgepflegten2FpriorisiertenProductBacklogs"]]) ist in GitLab sehr einfach durchzuführen. Hierfür werden die Issues einfach per "Drag and Drop" (Ziehen und Ablegen) in die gewünschte Ordnung bzw. Priorisierung gebracht. Im ersten Beispiel war die Reihenfolge der Issues #1,#3,#4,#5,#6,#7 und für das Projekt unsortiert. Nach der Sortierung ist die Reihenfolge der Issues #7,#6,#5,#4,#3,#1 (Sortierung willkürlich gewählt und dient nur zu Anschauungszwecke).
94
95 [[image:ProductBacklog3.png||data-xwiki-image-style-border="true"]]
96
97 == Erstellung neuer Listen ==
98
99 In GitLab können die Listen auch genutzt werden um beispielsweise Meilensteine oder Epics darzustellen (siehe [[Meilensteine und Epics>>doc:Main.GitLab.WebHome||anchor="HMeilensteineundEpics"]]). Auch der Status der Issues kann dargestellt werden (siehe [[Status>>doc:Main.GitLab.WebHome||anchor="HStatusbeiIssues"]]). Hierfür wird einfach die **"New list"**-Funktion genutzt.
100
101 [[image:Liste1.png]]
102
103
104 [[image:Liste2.png]]
105
106
107 [[image:Liste3.png]]
108
109
110 [[image:Liste4.png]]
111
112 = Erstellung eines Sprints =
113
114 In GitLab erfolgt die Erstellung eines Sprints in sogenannten **"Milestones"** (Meilensteine). Diese Option ist in der Projektnavigationsleiste unter dem Reiter **"Milestones" **vorzufinden. Um einen neuen Sprint zu erstellen wird die **"New Milestone"**-Option ausgewählt.
115
116 [[image:Sprint1.png||data-xwiki-image-style-border="true"]]
117
118 Damit ein neuer Sprint erstellt werden kann, wird der Sprint mit einem Titel, einem Start- sowie Enddatum und einer Beschreibung versehen. Das Sprintziel sollte in der Beschreibung festgehalten werden. Im unten aufgeführten Beispiel ist die Registrierung und die Anmeldung das angestrebte Sprintziel. Gespeichert wird der Sprint durch die "**Create milestone"**-Funktion
119
120 [[image:Sprint2.png||data-xwiki-image-style-border="true"]]
121
122 [[image:Sprint3.png||data-xwiki-image-style-border="true"]]
123
124 == Sprint-Backlog ==
125
126 Jetzt wurde erfolgreich ein Sprint erstellt. Jedoch fehlen bisher noch die Issues die benötigt werden um das Sprintziel zu erreichen. Dafür wird erneut der Reiter **"Issue boards" **(der Product-Backlog) angesteuert. Anschließend wird die Funktion **"New list"** ausgewählt.
127
128 [[image:Sprint4.1.png||data-xwiki-image-style-border="true"]]
129
130 Hierbei werden wieder verschiedene Optionen angeboten. Für die Erstellung eines Sprints bzw. der Durchführung der Sprintplanung, wird die Option **"Milestone"** und der eben erstellte Sprint als **"Value"** ausgewählt. Anschließend wird der Vorgang durch die **"Add to board"**-Funktion bestätigt.
131
132 [[image:Sprint5.png||data-xwiki-image-style-border="true"]]
133
134 [[image:Sprint6.1.png||data-xwiki-image-style-border="true"]]
135
136 Somit wurde erfolgreich ein sogenannter **Sprint-Backlog** (siehe [[Informationen zu Scrum>>doc:Main.Scrum.WebHome]]) erstellt. In der Sprint-Planungsphase wird vom kompletten Projektteam festgelegt, welche Issues im Sprint umgesetzt werden sollen um das selbst definierte Sprint-Ziel zu erreichen. Nachdem das Team sich geeinigt hat, werden die Issues aus dem Product-Backlog, per "Drag and Drop" (Ziehen und Ablegen) in dem Sprint-Backlog abgelegt.
137
138 [[image:Sprint8.png||data-xwiki-image-style-border="true"]]
139
140 == Schätzungen ==
141
142 Anschließend müssen die Issues geschätzt werden (siehe [[Schätzen>>doc:Main.Scrum.WebHome||anchor="HSchE4tzenvonAufwE4nden"]]). Dieser Vorgang dient der Schärfung des Verständnisses des gesamtem Projektteams. Hierbei ist es wichtig sich auf eine Werteskala (bspw. Fibonacci) zu einigen (diese sollte über die gesamte Projektdauer beibehalten werden). Die Ergebnisse werden dann direkt in den Issues unter dem Punkt "Weight" festgehalten.
143
144 [[image:SprintS.png||data-xwiki-image-style-border="true"]]
145
146 Die Sprint-Planung ist somit abgeschlossen und der fertiggestellte Sprint ist unter dem Reiter **"Milestones" **vorzufinden.
147
148 [[image:SprintE.png||data-xwiki-image-style-border="true"]]
149
150 [[image:SprintF.png||data-xwiki-image-style-border="true"]]
151
152 = Erstellung eines Wikis =
153
154 Im Softwareprojekt müssen viele Daten dokumentiert (siehe [[Anforderungsanalys>>doc:Main.Aufgabenstellung.WebHome||anchor="Teilaufgabe2:Anforderungsanalyse28Dokumentation29"]] und [[Entwurf>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe3:Entwurf28Dokumentation29"]] sowie [[Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]) werden und unter anderem auch ein Projekttagebuch (siehe [[Projekttagebuch>>doc:Main.Anforderungen Gruppen.WebHome||anchor="HProjekttagebuch"]] geführt werden. Dies wird in der Wiki-Funktion von GitLab umgesetzt. Diese Option ist in der Projektnavigationsleiste unter dem Reiter **"Wiki" **vorzufinden.
155
156 [[image:Wiki1.png||data-xwiki-image-style-border="true"]]
157
158 [[image:Wiki2.png||data-xwiki-image-style-border="true"]]
159
160 Im GitLab-Wiki muss die erste Seite die sogenannte **"Home"**-Seite sein. Sonst wird das Wiki nicht korrekt erzeugt. Die Seite wird mit der **"Create page"**-Funktion erstellt.
161
162 [[image:Wiki3.png||data-xwiki-image-style-border="true"]]
163
164 Um weitere Seiten zu erstellen, wird in der "Page"-Hierachie das "+" unter Home ausgewählt. Nach Erstellung der neuen Seite, wird diese wieder mit der **"Create page"**-Funktion erstellt.
165
166 [[image:Wiki4.png||data-xwiki-image-style-border="true"]]
167
168 (% class="wikigeneratedid" id="H" %)
169 [[image:Wiki5.png||data-xwiki-image-style-border="true"]]
170
171 = Zeiterfassung in GitLab =
172
173 Im Rahmen des Softwareprojekts sollt ihr eure Arbeitszeit präzise festhalten. Dazu könnt ihr direkt auf angelegten Issues/Tasks/User Stories in dem Bereich **Time tracking** eure Arbeitszeit Aufgabenspezifisch eintragen. In dem Fenster könnt ihr eintragen wie viel Zeit ihr gearbeitet habt, an welchem Tag ihr gearbeitet habt, um nachträgliches verbuchen von Arbeitszeit zu ermöglichen, und eine kleine Zusammenfassung angeben. Sollte bereits Zeit erfasst worden sein, muss über das Plus (siehe Bild oben rechts im roten Rahmen) Zeit gebucht werden.[[image:1754139824426-497.png]]