Skip to content

02 Guidlines zur Arbeit mit dem Repo

Nicole Schönwerth edited this page Sep 27, 2022 · 2 revisions

1. Issues

Issues stehen für einzlene To-Do-Items. Es gibt verschiedene Issue-Types, mit jeweils einem eigenen Issue-Template.

  • Orga
  • Feature
  • Bug
  • Enhancement
  • (UI)

Titel
Issues werden dann folgendermaßen benannt: type/issue-title

User Stories
Issues werden als User Stories formuliert. Dabei wird nach dem Prinzip "Als Nutzer:in möchte ich [Feature], um [Zweck]."

Akzeptanzkriterien
Auf die User Stories folgt eine Beschreibung der erforderlichen Akzeptanzkriterien, die mit Checkboxen zum Abhaken aufgelistet sind. Die Sichtbarkeit des Features muss immer als ein Akzeptanzkriterium aufgeführt sein. Diese Checkboxen werden abgehakt, sobald die zugehörige Aufgabe erledigt ist. Sind alle Checkboxen abgehakt, wird das Issue geschlossen.
Beim Schließen des Issues wird im Kommentar eine grobe Angabe gemacht, wie viel Zeit dafür aufgewendet wurde.

Beispiel:
Orga/Kanzleien anfragen
Es sollen Kanzleien angefragt werden, um Anwälte bei ihrer Arbeit zu beobachten und potenzielle Problemfelder zu identifizieren.

  • Mail aufsetzten
  • Anfragen rausschicken
  • ...

2. Arbeiten mit dem Kanban-Board

Erstellte Issues werden zu Kanban-Board hinzugefügt und deren Status regelmäßig aktualisiert.

  • Beim Erstellen des Issues: Hinzufügen
  • Bei Beginn der Bearbeitung: Verschieben nach "in progress"
  • Bei Beendigung/Schließen: Verschieben nach "done"

3. Branching

  • Master/Main-Branch: Laufende Version
  • Develop: Sammelstelle für bereits funktionierenden Code
  • Feature-/Bug-Branches: Branches, die jeweils einem Issue zugeordnet werden können
    Diese Branches werden ebenfalls nach der Art und ID des Issues benannt und tragen den Issue-Titel als Name.
    Beispiel: Enhancement/#513-Einfügen-von-Fehlermeldungen

Ist die Arbeit an einem Branch erstmal abgeschlossen, wird ein Pull Request in den Develop erstellt. Branches werden erst in den Develop gemerget, wenn dies von mind. 1 anderen Person approved wurde.

4. Commit-Messages

Commit-Messages bestehen aus dem Typ und der ID des zugehörigen Issues und einer kurzen Beschreibung in der Vergangenheit.
Beispiel: Enhancement/#513-Fehlermeldung-bei-Anmeldung-aktualisiert