Hoe kun je bijdragen?

Mis je functionaliteit die voor jou belangrijk is? Heb je een issue (fout of bug) gezien in een van onze API’s? Of heb je een wens of suggestie? Bijdragen aan Haal Centraal kan in verschillende vormen.

Huishoudelijk

Als je nog niet goed weet hoe Git en GitHub werkt, kun je hier iets meer over lezen in de tutorial. Hierin staat ook de workflow beschreven voor het voorstellen van wijzigingen (pull request). Het moet voor iedereen prettig zijn om een bijdrage te leveren, dus gaan we op een vriendelijke en respectvolle manier met elkaar om. Daarvoor hebben we een gedragscode. Nederlands is de voertaal, maar Engels is natuurlijk ook toegestaan, daar ontkomen we in dit vakgebied niet aan.

Bijdragen

Je kunt op drie manieren een bijdrage leveren:

  1. Issues indienen voor bugs, fouten, wensen en suggesties. Functionele wensen graag in de vorm van een user story.
  2. Bijdragen van anderen beoordelen, door te reageren op een issue of pull request.
  3. Wijzigen of aanvullen van deelproducten via een pull request.

Voordat je een wijziging indient via een pull request kun je overwegen eerst een issue in te dienen om te polsen of anderen in de community je voorgestelde wijziging ondersteunen. Dat verkleint de kans dat je tijd besteedt aan het maken van een wijziging die wordt afgewezen.

Pull requests

Houd pull requests zo klein mogelijk. Combineer liever geen verschillende functionele toevoegingen in één pull request.

In een pull request moet in de beschrijving worden aangegeven:

  • Wat het doel is van de Wijzigingen
  • Wat is gewijzigd in welke bestanden