Using the Github UI to Make Pull Requests/nl

Handleiding

Dit artikel helpt met het begrijpen en aanmaken van Pull Reqeusts op GitHub, zodat je kunt deelnemen aan een project zoals Joomla!.

Wat is een Pull Request?

Een Pull Request is een verzoek om code toe te voegen aan een Repository (project) op GitHub.

In wat simpelere taal: je dient een verzoek in voor het wijzigen van code in een project. Deze wijzigen kunnen de oplossing voor een bug zijn, maar bijvoorbeeld ook een nieuwe functie. GitHub heeft een gebruikersinterface die het erg makkelijk maakt om wijzigingen in te dienen. Je hoeft hiervoor geen extra software te installeren. Het enig dat je hoeft te doen is je registreren op GitHub.

Bekijk welke wijzigingen je wilt maken

Als eerst bekijk je wat je precies wilt gaan wijzigen.

Wij nemen het volgende voorbeeld: we willen een icoontje toevoegen aan het artikel info-blok. Namelijk een icoontje voor de naam van de auteur. Op het moment van schrijven staat deze er nog niet.

Vind het bestand dat je wilt aanpassen op GitHub

Als je nog geen account op GitHub hebt, kun je deze aanmaken op GitHub. Het is gratis en erg snel en makkelijk te doen. Ga hierna naar de Joomla! CMS repository en zoek het bestand dat je wilt wijzigen. Je kunt door de bestanden bladeren door op de map- en bestandsnamen te klikken.

Deze stap kan soms wat lastig zijn, omdat Joomla! meer dan 6000 bestanden telt. In ons voorbeeld hebben we het volgende bestand nodig: /layouts/joomla/content/info_block/author.php

Maak je wijzigingen

Navigeer naar het bestand, en klik op het potlood icoontje om het bestand te bewerken.

In ons voorbeeld voegen we op lijn 14 de volgende code toe: author.php

<span class="icon-user"></span>

Opmerking: je hebt wellicht de blauwe melding boven aan de pagina al opgemerkt. Deze melding vertelt je dat GitHub een kopie heeft gemaakt van het project, waar je je wijzigingen in kunt maken. Zo een kopie heet een Fork. De wijzigingen die je maakt in deze kopie kunnen worden gebruikt in het project. Als je meer wilt weten over hoe GitHub werkt kun je dit artikel lezen voor wat achtergrond informatie.

Voeg een titel en beschrijving toe

Onder de editor kun je een titel en een beschrijving toevoegen.

De titel moet zo kort mogelijk zijn, en duidelijk vertellen wat de PR doet.

De beschrijving bevat meer detailleerde informatie over de Pull Request en informatie over hoe deze getest kan worden. Zorg ervoor dat deze informatie zo compleet en duidelijk mogelijk is. Wanneer je een Pull Request maakt is het ook de gewoonte om het issue ID te vermelden in de beschrijving. Dit doe je door een # (hashtag) te typen, volgend door het ID nummer. Dit nummer kun je direct achter de titel van de Issue vinden, in dezelfde notatie.

Dien de Pull Request in

Klik op de knop "Propose file changes" en you Pull Request is aangemaakt!

En nu?

Het enige dat je nu hoeft te doen is afwachten totdat iemand de PR ziet en test. Als iemand reageert, ontvang je hier een email over. Het kan gebeuren dan iemand wat meer informatie wilt weten, dus probeer de reacties op jou PR zo goed mogelijk bij te houden.

Als de Pull Request twee maal succesvol is getest voegt een moderator het label "RTC" toe. RTC staat voor "Ready To Commit". Dit label verteld een administrator: Hé, ik ben succesvol getest en kan nu toegevoegd worden aan Joomla!. De administrator zal dan jou wijzigen toevoegen (Merge) aan de Joomla! CMS GitHub repository. Je PR is nu definitief doorgevoerd en zal in de volgende versie van Joomla! zitten!