Eerstejaars helpen - Trisjan/Freago GitHub Wiki

Eerstejaars helpen

Op deze pagina vertel ik hoe ik de eerstejaars heb geholpen bij hun code en pull requests.

Pull request Sejino

Samen met David heb ik een code design review gedaan bij de pull request van Sejino. Ik heb samen met David voornamelijk gekeken naar de changed files en de opbouw van de pull request. Ik heb de volgende feedback punten gegeven aan Sejino:

  • Zet voor de volgende keer een live link bij de pull request zodat we de website live kunnen zien.
  • Zet de issue erbij die opgelost door deze pull request.
  • Vertel hoe je het hebt getest. (Denk aan responsive, accessibility, performance etc. (optioneel)
  • Schrijf een kort stukje hoe de reviewer jouw code moet testen. (optioneel)
  • We zien in de titels van je commits dat je nederlands en engels gebruikt, gebruik één van de twee talen.
  • In dit artikel wordt besproken waarom de grootte van Pull Requests belangrijk is, wat de voor- en nadelen van kleinere Pull Requests zijn: https://athenian.com/blog/why-pull-request-size-matters.

Het viel me vooral op dat Sejino een lege pull request aan maakte, het bevatte een korte omschrijving en liet niet per se zien welke issue en/of welk probleem hiermee werd opgelost. Ook heb ik een artikel met hem gedeeld zodat hij kan lezen wat nou het belang is van een goede pull request. Zo kan hij zich verdiepen erin en in de toekomst dit in gedachte houden voor nieuwe pull requests.

Pull request Tygo

Samen met David heb ik een code design review gedaan bij de pull request van Tygo. Samen met David heb ik weer naar de zelfde punten gekeken bij Tygo, oftewel de changed files en de code daarin en de opbouw van de pull request. Wij hadden feedback op de volgende punten:

  • Zet voor de volgende keer een live link bij de pull request zodat we de website live kunnen zien.
  • Vertel hoe je het hebt getest. (Denk aan responsive, accessibility, performance etc. (optioneel)
  • Schrijf een kort stukje hoe de reviewer jouw code moet testen. (optioneel)
  • Je kan referreren naar code in specifieke files door een permalink te maken:

Wat ons opviel bij Tygo is dat hij een wat uitgebreidere pull request had vergeleken met Sejino. Hij maakte gebruik van video's in zijn pull request, hij vertelde ook welke issue opgelost werd door deze pull request. Dat deed hij heel goed. We mistten alleen nog een live url om de changes live te zien, dat is de enige tip die we mee willen geven.

Pull request Robin

Samen met David heb ik een code design review gedaan bij de pull request van Robin. Samen met David hebben we gekeken naar de zelfde punten als hierboven. We hadden de volgende punten als feedback voor de pull request van Robin:

  • Zet voor de volgende keer een live link bij de pull request zodat we de website live kunnen zien.
  • Zet de issue erbij die opgelost door deze pull request.
  • Vertel hoe je het hebt getest. (Denk aan responsive, accessibility, performance etc. (optioneel)
  • Schrijf een kort stukje hoe de reviewer jouw code moet testen. (optioneel)
  • In dit artikel wordt besproken waarom de grootte van Pull Requests belangrijk is, wat de voor- en nadelen van kleinere Pull Requests zijn: https://athenian.com/blog/why-pull-request-size-matters.

De pull reqeust was een beetje leeg, er werd wel verteld wat er gedaan is en wat het veranderd. Ik mistte alleen een before en after foto, en ik mistte een live url zodat ik het zelf kon testen. Verder heb ik ook het artikel mee gegeven over het belang van een goede pull request.

Reverten van commit met Lemuel en team

Lemuel en zijn team hebben tijdens een pull request per ongeluk de main gemerged met een oude branch waardoor de main niet meer klopte. De revert knop werkte wel maar telkens als hij de revert wilde pushen zag hij alsnog de verkeerde code staan. Ik heb de volgende stappen ondernomen om hun oude commit terug te krijgen in de main.

Revert

De revert is de meest logische optie bij het terug halen van een oude commit, echter werkte dit niet en kreeg hij een foutmelding wanneer hij terug wilde gaan naar deze commit. Deze optie viel dus al weg

Create branch from commit

Ik heb dus vanuit zijn laptop lokaal een nieuwe branch aangemaakt met de changes van de oude commit. De teamgenoot van Lemuel zei dat de code in de branch er nu goed uit zag, we hebben samen elke file nagekeken en hij zei me dat het er goed uit zag. Toen hebben we de branch gepublished en daarna maakte we een pull request aan. Bij het aanmaken van de pull request zei github dat er geen nieuwe veranderingen zijn. Ik snapte er niks van dus heb dit proces nogmaals verricht en heb in elk bestand waarvan hij de code wou een comment gezet zodat hij een change kon herkennen. Uiteindelijk herkende hij dit maar bij het mergen was de code als nog niet mee gegaan naar de main. Dus het probleem was nog steeds niet opgelost.

Copy paste werk (de lelijke manier)

Uiteindelijk heb ik de lelijkste manier gekozen om hem uit de brand te helpen met het probleem. Ik deed een checkout naar de commit met de code die hij wou, vervolgens kopieerde ik alle files van de repo naar zijn bureaublad. Vervolgens ging ik terug naar de nieuwste versie van de main. Ik sleepte alle bestanden zijn directory in en heb dit toen gepusht naar github. Dit werkte en hij had alle code terug.

Uitleggen van een goede pull request maken

Ik heb samen met hun gezeten om uit te leggen hoe je een goede pull request kan maken. Ik liet hun de "merge into" functie zien op github desktop en hoe deze werkt. Daarna heb ik hun uitgelegd dat het dus ook van belang is dat je branch de changes van de main ook mee krijgt zodat je geen oude code merged wanneer je een pull request maakt.