User stories op GitHub

Op GitHub maak je voor elke user story een issue. Elk issue krijgt automatisch een nummer: #1, #2, #3… Al je issues zet je op een scrumboard (bij GitHub heet dat een Project).

Issue maken

  1. Ga op github.com naar je repo, tabje Issues
  2. Klik op New issue
  3. Titel: je user story, bijv. Als gebruiker wil ik kunnen inloggen
  4. Rechts bij Projects: kies je scrumboard
  5. Klik op Create

Scrumboard maken

  1. In je repo: tabje Projects → New project
  2. Kies Board
  3. Je krijgt de kolommen Todo, In Progress en Done

Closes #1

Nu het handige deel. Typ je in je pull request Closes #1? Dan gebeurt er na het mergen vanzelf dit:

  1. Issue #1 gaat dicht
  2. De kaart op je scrumboard schuift naar Done

Je hoeft dus niks meer te verslepen!

Het nummer na de # is het nummer van je issue. Die zie je in de titel van het issue op GitHub.

Deze woorden werken allemaal:

Closes #1
Fixes #1
Resolves #1

Zie het in actie

Dit is een scrumboard met een pull request eronder. Klik op Merge pull request. Probeer daarna ook de andere voorbeelden.

Scrumboard — Sprint 1
Todo
In Progress
Done
Beschrijving van je pull request:
Probeer ook:

Wat heb je gezien?

  • Closes #1 → kaart #1 gaat naar Done
  • Alleen #3 zonder Closes → er gebeurt niks
  • Closes #1, #2 → alleen #1 gaat dicht! Schrijf Closes #1, closes #2

Waar typ je het?

In de beschrijving van je pull request. Dat is het grote tekstvak onder de titel als je de PR maakt.

Met de terminal

gh pr create --title "Loginpagina" --body "Closes #1"

Vergeten? Geen probleem. Open de PR op github.com, klik bij de beschrijving op ··· → Edit en voeg Closes #1 toe. Doe dit voordat je merget.

Veelgemaakte fouten

Fout: de kaart gaat niet naar Done.

Check:

  • Is de PR al gemerged? Alleen een PR maken is niet genoeg
  • Heb je gemerged in main? In een andere branch werkt het niet
  • Staat het issue op je scrumboard? Check rechts in het issue bij Projects

Fout: Closes #1 in de titel of in een comment zetten.

Goed: altijd in de beschrijving van de pull request.

Fout: Closes 1 (zonder #) of Closing #1.

Goed: Closes #1 — precies zo.

Voor de eigenaar van het scrumboard:

Dat de kaart vanzelf naar Done gaat, regelt het Project. Open je Project → ··· (rechtsboven) → Workflows. Check of Item closed en Pull request merged aan staan. Normaal staat dat al goed.