Skip to main content

πŸ“‹ Issue-referenties in Logboeken - Quickstart

Jan Gillis
Leerkracht informatica GO! atheneum en leefschool De Tandem

Voor leerlingen: Hoe je issue-nummers in je logboek toevoegt

Het voordeel​

In plaats van lange GitHub-links (die extern toch niet werken), schrijf je gewoon #nummers in je logboek.

Voorbeeld VOOR (lang en niet bruikbaar voor externen):​

- [Variabele grootheden op dash](https://github.com/GO-atheneum-De-Tandem/WeerWijs/issues/102)

Voorbeeld NA (simpel, automatisch opgemaakt):​

- Variabele grootheden op dash β†’ #102

Hoe te gebruiken​

1. In "Volgende stappen" sectie​

### Volgende stappen
- Database optimization voor performance β†’ #105
- Meerdere sensoren per locatie testen β†’ #108
- UI verbetering dashboard β†’ #112

2. In gewone tekst​

### Problemen of vragen
We hebben een bug gevonden (#98) in de database query die opgelost moet worden.
Dit sluit aan bij issue #99 voor data validation.

3. Zoveel issues als je wilt​

### Volgende stappen
- Fix bugs β†’ #102, #103, #104
- Implement features β†’ #105, #106
- Documentation β†’ #107

Hoe ziet het eruit op de website?​

Voor de blogbezoeker (extern)

  • Ziet gewoon: "Volgende stappen: database optimization β†’ #105"
  • Het is een mooie badge, niet aanklikbaar (want het is privΓ©)
  • Wordt automatisch opgemaakt door onze plugin

Voor jou in het logboek (in markdown)

  • Gewoon schrijven: #105
  • Meer niks nodig!

Tips​

βœ… DO's:

  • Zorg dat je het juiste issue-nummer gebruikt
  • Zet een spatie voor het #: #102
  • Gebruik in "Volgende stappen" sectie
  • Kan ook in "Problemen" sectie

❌ DON'Ts:

  • #102 zonder spatie aan het begin kan soms niet werken
  • Gebruik niet #issue-102 of issue-102
  • Hoeft niet [#102]() of links zelf aan te maken

Vragen?​

Dit is een automatische plugin - je hoeft niks in te stellen. Gewoon #nummers schrijven en de rest regelt zich zelf! πŸš€