Een pull request samenvatten voor een reviewer
Een pullrequestsamenvatting helpt een reviewer het probleem, de aanpak en aandachtspunten te begrijpen. Ze is het nuttigst wanneer de beschrijving de werkelijk aangeleverde wijzigingen weerspiegelt.
Begin met het juiste materiaal.
- Wat je aanlevert
- een uitgeklapte tekstdiff en zichtbare issuecontext op de pagina.
- Het beoogde resultaat
- Sla een samenvatting op van waargenomen wijzigingen, de aanleiding en tests die daadwerkelijk uit het bewijsmateriaal blijken.
Hoe de workflow werkt.
Leg uit wat is veranderd en waarom en benoem daarna vragen over gedrag, compatibiliteit of migratie die door de diff en notities worden ondersteund. Houd uitgevoerde tests gescheiden van slechts voorgestelde tests.
Wat je in het resultaat controleert.
Vergelijk de samenvatting met de gewijzigde bestanden voordat je publiceert. Beweer niet dat een test geslaagd is of een risico is weggenomen tenzij het aangeleverde bewijs dat resultaat vaststelt.
Bekijk de Markdown-voorvertoning om naast de tekst ook koppen, lijsten en links te controleren. Bewaar bronverwijzingen bij het document, zodat een beoordelaar belangrijke uitspraken kan herleiden tot je aangeleverde materiaal.
Leer van het uitgewerkte voorbeeld.
Het downloadbare Markdown-voorbeeld laat één mogelijke indeling van het resultaat zien. Lees het naast het bronvoorbeeld en herken vastgelegde feiten, voorgestelde tekst en vragen die nog een antwoord nodig hebben.
Het aangeleverde voorbeeld is ter illustratie. Het is geen vastgelegde uitvoering met jouw gegevens.
Download het voorbeeld ↓Gebruik het met je eigen materiaal.
- Open de bron waarmee je wilt werken en activeer WebAct op dat tabblad.
- Kopieer de taak uit het bovenste blok, voeg vereiste velden of voorkeuren toe en controleer de voorgestelde acties.
- Vergelijk het eerste resultaat met je bron. Vraag waar nodig om een gerichte correctie of verfijning.