- Einen guten Titel wählen
- Die Beschreibung
- Passende Labels hinzufügen
- Relevante Issues verlinken
- Und zum Schluss
Falls du nicht im Fachschaftsrat bist und für einige Einstellungen keine Rechte hast, wird sich ein Mitglied des Fachschaftsrats darum kümmern.
Einen guten Titel wählen
Der Titel sollte kurz klarstellen worum es geht, was passieren soll und wann.
- worum
- Worum geht es (das Subjekt)? Beispiel: Haushaltsplan
- was
-
Es ist auch wichtig, was genau mit dem Subjekt passieren soll. Der Beispieltitel "Haushaltsplan" kann alles mögliche heißen, daher sollte er präziser sein:
- Haushaltsplan erstellen
- Haushaltsplan überarbeiten
- Haushaltsplan archivieren
- wann (wenn notwendig)
-
Vergiss nicht, dass diese Issues nie gelöscht werden sollten. Dein Issue kann also weit in der Zukunft bei Suchanfragen auftauchen. Daher sollte bei regelmäßigen Sachen aus dem Titel auch hervorgehen, wann der Issue relevant ist:
Haushaltsplan 2022 erstellen
Bei speziellen Ereignissen ist dies aber nicht unbedungt notwendig. "Feedback zu Distributed Systems weiterleiten" beispielsweise könnte zwar häufiger auftreten, wenn es aber keine Tradition ist sollte das Datum unter dem Issue vollkommen ausreichen.
Die Beschreibung
Die Beschreibung sollte so viel Informationen zum Thema zusammenfassen wie möglich. Was genau soll wie gemacht werden? Was wurde bereits dazu besprochen? Wenn es zu einem Thema nur wenig Informationen gibt sollte genau das auch in der Beschreibung stehen.
→ Die Beschreibung sollte Leute vor einer Sitzung auf diesen TOP vorbereiten.
Unteraufgaben kannst du als Aufgabenliste hinzufügen (- [ ] <Text>), und bei Bedarf eigene Issues dafür erstellen (bsp. wenn es viel Diskussionsbedarf dazu gibt).
(Außerdem ist es eine gute Idee, den weiteren Verlauf des Themas in den Kommentaren zu dokumentieren und die Beschreibung ggf. zu aktialisieren)
Passende Labels hinzufügen
- Zu welchen Bereichen gehört das Thema?
- Handelt es sich hierbei um ein Typ::Projekt?
Dies ist der Fall wenn der Issue den Verlauf eines längeren Projekts mit mehreren Unteraufgaben verfolgen soll. - Soll das Thema auf der nächsten Sitzung als TOP behandelt werden?
- Oder reicht die Zeit nicht mehr weil es Dringend ist?
Sieh dir am Besten einmal die Liste der Labels an.
Relevante Issues verlinken
Issues, die zu diesem gehören oder zu denen dieser gehört, solltest du nach dem Erstellen unter Linkes Issues hinzufügen. (Oder bereits während des Erstellens mit /relate #<nummer>)
Sonstige relevante Issues kannst du mit #<nummer> erwähnen.
Und zum Schluss
Vergiss auch folgendes nicht:
- Sind die richtigen Leute/Gruppen
@-Erwähnt? - Wer ist zuständig? Setze diese Person als Assignee
- Gibt es ein Fälligkeitsdatum?
- Ist das Thema nicht öffentlich? Markiere den Issue als confidential.