einführung-issues.md aktualisiert

This commit is contained in:
buchwaldchassee 2024-07-14 14:09:35 +00:00
parent bf928157be
commit 8636488c02

View file

@ -11,3 +11,33 @@ In jedem Repository werden die dazugehörigen Issues angezeigt:
Wenn man "Issues" anklickt, werden alle offenen Issues angezeigt. Wenn ein neues Issue angelegt werden soll, kann man auf den Button neues Issue klicken:
![](https://pad.gwdg.de/uploads/7f61f985-ea11-462f-a065-27f994a888ba.png)
Nun kann das Issue angelegt werden:
![](https://pad.gwdg.de/uploads/e7c6a2f5-f758-42ba-b81f-ffc9fd030109.png)
Trage dazu einen Titel mit der jeweiligen Aufgabe, Herausforderung oder Fragestellung ein, z.B. "Test-Issue für Git anlegen". Nun kannst du im Kommentarfeld noch eine Beschreibung hinterlassen und durch @-Mention Personen markieren, für die das Issue relevant ist oder die Aufgaben übernehmen sollen oder an die du Rückfragen hast. Theoretisch können auch Zuständige zugewiesen werden, netterweise fragt man die jeweilige Person vorher, wie die Kapazitäten sind und ob sie die Aufgabe übernehmen kann / möchte, damit nicht eine Person am Ende alle Issues zugewiesen bekomm. Personen können sich auch selbst als Zuständige eintragen. So können Aufgaben im Team verteilt werden.
### Hinweis:
Beachte, dass andere Personen mit dem Titel etwas anfangen können oder durch die Beschreibung und die Labels nachvollziehen können, worauf sich das Issue bezieht, sonst wird die Zusammenarbeit schwierig. Falls der Titel unverständlich bzw. unpräzise ist, kann er auch im Nachhinein noch bearbeitet werden. Klicke dazu oben rechts in der Ecke auf den grauen Button "Bearbeiten" (neben dem orangenen Button "Neues Issue").
Man kann die Issues auch mit Labels markieren, um sie zu kategorisieren. Es kann z.B. das Label "contribution-welcome" gesetzt werden, um andere Personen zur Beteiligung und offenen Zusammenarbeit zu ermutigen. Durch Labels wie z.B. "Technischer Support" können auch Zuständigkeiten besser zugeordnet werden (z.B. Technikteam vom CI).
### Hinweis:
Labels sind keine Tags! Es können auch Tags vergeben werden. Tags sind ein Werkzeug zur Markierung wichtiger Punkte in der Commit-Historie (z.B. v1 für Version 1 eines Dokumentes etc.), während Labels dazu dienen, Aufgaben und Tickets innerhalb von Projekten zu kategorisieren und zu priorisieren. Beide Konzepte sind essenziell, um große und komplexe Projekte zu verwalten. Durch das Tagging werden Issues also einem bestimmten Arbeitsschritt zugeordnet (also z.B. Dokumentation V1), das Label kategorisiert den Arbeitsauftrag also z.B. "high-priority" und "documentation" mit der Beschreibung "Kennzeichnet die Notwendigkeit für Verbesserungen oder Ergänzungen der Dokumentation". Wie Labels und Tags hinzugefügt werden können, erfährst du [hier](Link zu Dok Labels & Tags).
Man kann Issues auch mit Meilensteinen oder Projekten verknüpfen, um sie besser zuzuordnen und den Stand der Projekte anzuzeigen (was wurde bereits bearbeitet, was ist noch zu tun, welche Meilensteine wurden erreicht / sind noch offen usw.). Zudem können ein Fälligkeitsdatum und die geplante Arbeitszeit, die für die Bearbeitung des Issues benötigt wird, eingetragen werden und/oder die Arbeitszeit wird gestoppt. Durch die Zeiterfassung wird nachvollziehbar, wie lange und wann Personen an einem Issue gearbeitet haben.
Issues können auf referenziert und damit auf andere Aufgaben bezogen werden bzw. mit anderen Issues verknüpft werden. Das ist insbesondere bei Arbeitspaketen mit aufeinander bezogenen Aufgaben sinnvoll.
Sind Aufgaben erledigt, Fragen geklärt oder Herausforderungen gemeistert, können Issues geschlossen werden. Das ist für den Workflow wichtig, damit sich die Issues nicht häufen und es nicht unübersichtlich wird!
Dazu kannst du entweder auf Issue schließen klicken oder falls ein Issue versehentlich erstellt wurde, es komplett löschen:
![](https://pad.gwdg.de/uploads/b5867158-d2f8-4064-858c-86a9b06f51cf.png)
Alle geschlossenen Issues findet man in der Übersicht, bei Bedarf können sie auch wieder geöffnet werden:
![](https://pad.gwdg.de/uploads/7a9a2a82-0084-4d29-9550-f87702e04549.png)