Tips voor het aanmaken van een merge requests

• Merge altijd eerst de main branch terug in je feature branch voordat je een merge request aanmaakt. Hierdoor kun je testen of je wijzigingen ook werken in combinatie met de wijzigingen op de main branch.
• Voeg een beschrijving toe met alle wijzigingen die onderdeel zijn van je merge request. Als je er visuele aanpassingen zijn kun je ook screen shots toevoegen.
• Beperk de grootte van een merge request. Hoe kleiner de hoeveelheid wijzigingen, des sneller je werk is nagekeken en des te beter het commentaar.
• Lees je merge requests altijd eerst zelf snel door voordat je ze naar andere doorstuurt. Vaak kun je zelf al veel foutjes zien.
• Laat een commentaar op een wijziging altijd sluiten door de persoon die het commentaar geplaatst heeft. Zelf met kleine aanpassingen kun je nieuwe foutjes introduceren. Het is ook mogelijk dat je het commentaar verkeert interpreteert.

Tips voor het geven van feedback op een merge request

• Wees altijd vriendelijk wanneer je commentaar plaatst op iemand anders zijn werk. Feedback krijgen is belangrijk, maar niet altijd fijn.
• Gebruik bronnen in je commentaar. Als je bijvoorbeeld ziet dat iemand zich niet aan een coding convention houdt, kun je een artikel die uitlegt waarom dit een best practice is.
• Stel vragen. Een merge request is niet alleen ter controle, maar ook om kennis te delen. Als je niet begrijpt waarom iemand een bepaalde wijziging heeft gedaan, vraag dan om toelichting in een comment.
• Wees redelijk qua eisen. Maak het onderscheid tussen commentaar dat echt verwerkt moet worden en “schoonheidsfouten”. Communiceer dit verschil in je commentaar.