Een Pull Request aanmaken met de gebruikersinterface van GitHub

From Joomla! Documentation

This page is a translated version of the page Using the Github UI to Make Pull Requests and the translation is 84% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎Nederlands
Handleiding

Dit artikel helpt met het begrijpen en maken van een Pull Reqeusts op GitHub, zodat je kunt deelnemen aan een project zoals Joomla!. Veel wijzigingen, inclusief bug fixes en functionele toevoegingen kunnen ingevoerd en beoordeeld worden via de normale GitHub pull request werkflow.

Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.

Before making a pull request

A hastily proposed pull request can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the pull request can make the process smoother.

Although there is no single way to prepare for submitting a pull request, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the pull request may be desirable. Although it may seem like a useful feature or bug fix, there may be reasons it cannot work that you have not considered (or could not know about).

As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the pull request is worth pursuing. To get feedback, we suggest you join the Volunteers Portal and join Glip to ask other developers. Once you are ready, we suggest, before doing any code, you submit an issue to the Joomla! issue tracker with "RFC" at the beginning. That will create a request for comments which will help you to identify any additional work or issues you may have to overcome to get your idea accepted.

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 eerste 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.

Infoblock before.png

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

Github joomlacms.png

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>

Github filechange.png

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'n 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.

Github description.png


Dien de Pull Request in

Klik op de knop "Propose file changes" en daarna op de knop "Create Pull request". Jou pull request is nu gemaakt!

Create pull request.PNG
Create pull request.PNG


En nu?

Het enige dat je nu hoeft te doen is afwachten totdat iemand de PR test. Als iemand reageert, ontvang je hierover een email. Het kan gebeuren dat iemand wat meer informatie wil, 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 vertelt een administrator: Deze PR is succesvol getest en kan nu toegevoegd worden aan Joomla!. De administrator zal dan de wijzigen toevoegen (Merge) aan de Joomla! CMS GitHub repository. Uw PR is nu definitief doorgevoerd en zal in de volgende versie van Joomla! zitten! als het het oplossen van een bug was of in een punt-release als de PR een nieuwe functie was.