Belangrijk

Vertalen is een inspanning van de gemeenschap waaraan u deel kunt nemen. Deze pagina is momenteel voor 100.00% vertaald.

1. Een stap-voor stap bijdrage

Notitie

Hoewel de QGIS-Documentation wordt gebruikt om het proces te demonstreren, zijn alle hieronder staande opdrachten en stappen ook van toepassing op QGIS-Website.

Als u deze regels leest is dat zeker omdat u bereid bent om bij te dragen aan het schrijven van documentatie voor QGIS en zoekt naar een manier waarop. U bent op de juiste plaats! Het huidige document zal u door de verschillende manieren leiden om dit doel te bereiken, u de belangrijkste te volgen stappen laten zien, de trucs die u kunt gebruiken en de valkuilen die u zou moeten kennen.

Aarzel niet om hulp te krijgen daarom te vragen in een opmerking voor het probleem dat u probeert te repareren of schrijf naar de lijst van het QGIS-community-team. Meer details op Documentatie schrijven.

Laten we nu in het proces duiken.

Bronnen voor documentatie worden opgeslagen met het versie-controlesysteem git en zijn beschikbaar in GitHub op https://github.com/qgis/QGIS-Documentation. Een lijst van te repareren problemen en uit te leggen mogelijkheden is te vinden op https://github.com/qgis/QGIS-Documentation/issues.

Tip

Als u voor de eerste keer bijdraagt en niet precies weet waar u zou moeten beginnen, bent u misschien geïnteresseerd in het bekijken van onze welcoming issue reports.

Er zijn twee belangrijke manieren, niet onderling exclusief, om de bestanden aan te passen:

  1. De GitHub webinterface gebruiken

  2. Gereedschappen voor de opdrachtregel van Git gebruiken.

1.1. De GitHub webinterface gebruiken

De webinterface van GitHub stelt u in staat het volgende te doen:

  • bestanden bewerken

  • uw wijzigingen bekijken en indienen

  • een pull request maken om uw wijzigingen te laten invoegen in de hoofdopslagplaats

  • branches maken, bijwerken of verwijderen

Als u nog niet bekend bent met de vocabulaire voor git en GitHub, wilt u misschien het GitHub-project Hello-world lezen om enige basis vocabulaire en acties te leren die hieronder zullen worden gebruikt.

Notitie

Als u een gerapporteerd probleem repareert

Als u wijzigingen maakt om een probleem te repareren, voeg dan een opmerking aan het rapport van het probleem toe om het aan uzelf toe te wijzen. Dit voorkomt dat meer dan één persoon werken aan hetzelfde probleem.

1.1.1. QGIS-Documentation forken

Er van uitgaande dat u al een GitHub account heeft, dient u eerst de bronbestanden van de documentatie te kopiëren (fork).

Navigeer naar de pagina opslagplaats voor QGIS-Documentation en klik op de knop githubFork aan de rechter bovenkant.

In uw GitHub account zult u een opslagplaats QGIS-Documentation (https://github.com/<YourName>/QGIS-Documentation) vinden. Deze opslagplaats is een kopie van de officiële opslagplaats van QGIS-Documentation waar u volledige schrijftoegang toe hebt en u kunt wijzigingen maken zonder de officiële documentatie te beïnvloeden.

1.1.2. Wijzigingen maken

Er zijn verschillende manieren om bij te dragen aan de documentatie voor QGIS. We geven ze hieronder afzonderlijk weer, maar u kunt zonder problemen overstappen van het ene proces naar een ander.

Alternatief 1: Gebruik de sneltoets Bewerken op Github

Pagina’s op de website voor documentatie van QGIS kunnen snel en eenvoudig worden bewerkt door te klikken op de link Edit on GitHub aan de rechterbovenkant van elke pagina.

  1. Dit zal het bestand openen in de branch qgis:master met een bericht aan de bovenzijde dat u mededeelt dat u geen rechten voor schrijven heeft voor deze opslagplaats en dat uw wijzigingen zullen worden toegepast in een nieuwe branch van uw opslagplaats.

  2. Maak uw wijzigingen. Omdat de documentatie is geschreven met de syntaxis voor reStructureText, afhankelijk van uw wijzigingen, wilt u misschien steun zoeken bij de richtlijnen voor schrijven van documentatie.

  3. Als u gereed bent kunt u aan de onderzijde van de pagina een opmerking plaatsen over welke wijzigingen u gemaakt heeft en klik daarna op Propose changes. Dit zal een nieuwe branch <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches>`_ (patch-xxx) in uw opslagplaats maken.

  4. Nadat u heeft geklikt op Propose changes zal GitHub navigeren naar de pagina Comparing changes.

    • Als u klaar bent met het maken van wijzigingen, ga dan door met Wijzigingen vergelijken in het gedeelte Wijzigingen delen via Pull Request hieronder.

    • Als er aanvullende wijzigingen zijn die u wilt maken vóór u ze bij QGIS indient, volg dan deze stappen:

      1. Navigeer naar uw fork van QGIS-Documentation (https://github.com/<YourName>/QGIS-Documentation)

      2. Klik op githubBranch en zoek naar de branch patch-xxx. Selecteer deze patch branch. De knop githubBranch zal nu laten zien Branch: patch-xxx

      3. Spring verder naar Bestanden aanpassen hieronder.

Notitie

De sneltoets Bewerken op GitHub is ook beschikbaar in het keuzemenu aan de onderzijde van de linkerzijbalk.

Alternatief 2: Maak een ad hoc branch in uw opslagplaats voor Documentation

U kunt bestanden direct bewerken in uw fork van de QGIS Documentation.

Zorg er eerst voor dat uw branch master is bijgewerkt met de branch qgis:master Om dat te doen:

  1. Ga naar de hoofdpagina van uw opslagplaats, d.i. https://github.com/<YourName>/QGIS-Documentation. De branch master zou actief moeten zijn met een vermelding dat hij up to date is met qgis/QGIS-Documentation:master of niet.

    Als het commits heeft die ahead zijn van de branch upstream zou u beter de eerder genoemde alternatieve sneltoets-knop gebruiken voordat u uw branch master uitlijnt

    Als het alleen commits behind heeft:

    1. Vergroot het keuzemenu Fetch Upstream aan de rechterkant. U kunt

      • Compare de branches en nieuwe wijzigingen zien in de hoofd-opslagplaats

      • Fetch and merge: brengt wijzigingen vanuit de branch upstream naar die van u.

    2. Laten we klikken op Fetch and merge: na dit proces zal uw branch vermeld zijn als up to date met qgis/QGIS-Documentation:master.

  2. Klik op githubBranch in de linkerbovenhoek van uw fork van de opslagplaats QGIS-Documentation en voer een unieke naam in in het tekstveld om een nieuwe branch te maken. De naam van de nieuwe branch zou gerelateerd moeten zijn aan het probleem dat van plan bent te repareren. De knop githubBranch zou nu Branch: branch_naam moeten laten zien

  3. U bent nu klaar om er nieuwe wijzigingen in te maken.

Let op

Maak uw wijzigingen in een ad hoc branch, nooit in de branch master

Als conventie, probeer het maken van wijzigingen in uw branch master zoveel mogelijk te vermijden, met uitzondering van het samenvoegen van de aanpassingen vanuit de branch master van qgis/QGIS-Documentation naar uw kopie van de opslagplaats QGIS Documentation. Afzonderlijke branches stellen u in staat aan verschillende problemen tegelijkertijd te werken zonder last te hebben van andere branches. Als u een fout maakt kunt u altijd een branch verwijderen en opnieuw beginnen door een nieuwe te maken vanuit de master branch.

1.1.3. Bestanden aanpassen

  1. Blader door de bronbestanden van uw fork van QGIS-Documentation naar het bestand dat moet worden gewijzigd

  2. Maak uw aanpassingen, rekening houdende met de richtlijnen voor het schrijven van documentatie

  3. Als u klaar bent, navigeer naar het frame Commit Changes onder op de pagina, maak een korte opmerking over uw wijzigingen en klik op Commit Changes om de wijzigingen direct op te nemen in uw branch. Zorg er voor dat Commit directly to the branch_naam branch. is geselecteerd.

  4. Herhaal de vorige stappen voor elk ander bestand dat moet worden bijgewerkt om het probleem op te lossen.

1.1.4. Deel uw wijzigingen via Pull Request

U dient een pull request te maken om uw wijzigingen ingevoegd te krijgen in de officiële documentatie.

Notitie

Als u een link Bewerken op GitHub gebruikte

Nadat u uw wijzigingen hebt ingediend zal GitHub automatisch een nieuwe pagina openen die de wijzigingen vergelijkt tussen die in uw branch patch-xxx en de branch master van qgis/QGIS-Documentation.

Ga door met Stap 2 hieronder.

Een nieuw Pull Request beginnen

Navigeer naar de hoofdpagina van de opslagplaats QGIS-Documentation en klik op New pull request.

Wijzigingen vergelijken

Als u twee dialoogvakken ziet, één met base:master en de ander met compare:branch_name (zie afbeelding), zal dit alleen uw wijzigingen samenvoegen vanuit uw branches naar uw eigen master branch. Klik op de link compare across forks om dit op te lossen.

../../_images/githubCompareAcrossForks.png

Fig. 1.1 Als uw pagina Comparing changes er uitziet zoals deze, klik dan op de link compare across forks.

U zou vier keuzemenu’s moeten zien. Deze zullen u in staat stellen de wijzigingen die u heeft gemaakt in uw branch te vergelijken met de master branch waar u ze in wilt samenvoegen. Dat zijn:

  • base fork: de fork waarmee u uw wijzigingen wilt samenvoegen

  • base: de branch van de base fork waarmee u uw wijzigingen wilt samenvoegen

  • head fork: de fork die de wijzigingen heeft die u wilt invoegen in de base fork

  • compare: de branch met deze wijzigingen

Selecteer qgis/QGIS-Documentation als de base fork met master als basis, stel de head fork in op uw opslagplaats <YourName>/QGIS-Documentation, en stel compare in op uw aangepaste branch.

../../_images/githubCreatePullRequestComparison.png

Fig. 1.2 Wijzigingen vergelijken tussen qgis/QGIS-Documentation en uw opslagplaats

Een groen vinkje met de woorden Able to merge geeft aan dat uw wijzigingen zonder conflicten kunnen worden samengevoegd met de officiële documentatie.

Klik op de knop Create pull request.

Waarschuwing

Als u ziet githubCantMerge

Dit betekent dat er conflicten zijn. De bestanden die u aanpast zijn niet up to date met de branch die u als doel hebt gekozen, omdat iemand anders iets heeft ingediend dat conflicteert met uw wijzigingen. U kunt nog steeds het pull request maken, maar u dient eerst bestaande conflicten op te lossen om het samenvoegen te kunnen voltooien.

Tip

Hoewel uitgegeven en vertaald, worden de laatste versie en de documentatie van QGIS nog steeds onderhouden en bestaande problemen worden opgelost. Indien u problemen oplost voor een andere uitgave, vervang dan de base van master naar de van toepassing zijnde branch release_… in de eerder uitgelegde stappen.

Uw pull request beschrijven

Een tekstvak zal openen: vul relevante opmerkingen in voor het probleem dat u aanpakt.

Als het een relatie heeft met een bepaald probleem, voeg dan het nummer van het probleem toe aan uw opmerkingen. Dat wordt gedaan door een # en het nummer van het probleem in te voeren (bijv. #1234). Indien dat wordt voorafgegaan door termen als fix of close, zal het betreffende probleem worden gesloten zodra het pull request is samengevoegd.

Voeg links toe van pagina’s van de documentatie die u wijzigt.

Klik op Create pull request.

Pull request nakijken en opmerkingen plaatsen

Zoals hierboven te zien kan iedereen wijzigingen voor de documentatie indienen via pull requests. Op dezelfde wijze kan iedereen pull requests met vragen en opmerkingen nakijken. Misschien komt de stijl van schrijven niet overeen met de richtlijnen voor het project, mist de wijziging enkele belangrijke details of schermafdrukken, of misschien ziet alles er goed uit en is alles in orde. Nakijken helpt het verbeteren van de kwaliteit van de bijdragen, zowel in vorm als substancieel.

Een pull request nakijken:

  1. Navigeer naar de pagina met pull requests en klik op het pull request waarop u wilt reageren.

  2. Aan de onderzijde van de pagina vindt u een tekstvak waar u algemene opmerkingen over het pull request kunt achterlaten.

  3. Opmerkingen toevoegen over specifieke regels,

    1. Klik op githubFilesChanged en zoek naar het bestand waarover u opmerkingen wilt maken. U moet misschien klikken op Display the source diff om de wijzigingen te bekijken.

    2. Scroll naar de regel waarover u de opmerking wilt plaatsen en klik op de githubBluePlus. Dat zal een tekstvak openen waarin u uw opmerking kunt plaatsen.

Specifieke opmerkingen voor regels kunnen worden gepubliceerd, ofwel:

  • als enkele opmerking, met de knop Add single comment. Zij worden gepubliceerd als u doorgaat. Gebruik dit alleen als u slechts een paar opmerkingen hebt toe te voegen of bij het antwoorden op een andere opmerking.

  • of als deel van het nakijken, door te drukken op de knop Start a review. Uw opmerkingen worden niet automatisch verzonden na valideren, wat het voor u mogelijk maakt ze te bewerken of later te annuleren, om een samenvatting van de belangrijkste punten van het nakijken toe te voegen of globale instructies met betrekking tot het pull request en of u het goedkeurt of niet. Dit is de meest handige manier omdat het meer flexibel is en u in staat stelt het nakijken te structureren, de opmerkingen te bewerken, publiceren als u klaar bent en één enkele notificatie te versturen naar de volgers van de opslagplaats en niet één notificatie voor elke opmerking. Bekijk voor meer details.

../../_images/githubAddLineComment.png

Fig. 1.3 Opmerking voor een regel met een suggestie om te wijzigen

Opmerkingen voor regels kunnen suggesties inbedden die de schrijver van het pull request kan toepassen op het pull request. Klik, om een suggestie toe te voegen, op de knop githubSuggestions Insert a suggestion aan de bovenzijde van het tekstvak voor de opmerking en pas de tekst aan binnen het blok voor de suggestie.

Tip

Voorkeur voor indienen van suggesties voor uw pull request als bulk

Als een auteur van een pull request vermijd, bij het direct verwerken van de terugkoppeling van het nakijken in uw pull request, het gebruiken van de knop Commit suggestion aan de onderzijde van de opmerking als u veel suggesties moet verwerken en de voorkeur hebt om ze toe te voegen als een bulk-commit, dat is:

  1. Schakel naar de tab githubFilesChanged

  2. Druk op Add suggestion to batch voor elke wijziging die u zou willen opnemen. U zult een teller zien verhogen als u doorgaat.

  3. Druk op een van de knoppen Commit suggestions als u klaar bent om de suggesties toe te voegen aan uw pull request, en voer een opmerking in die de wijzigingen beschrijft.

Dit zal de aanpassingen aan uw branch toevoegen als één enkele commit, wat resulteert in een meer leesbare geschiedenis van wijzigingen en minder notificaties voor de volgers van de opslagplaats. Incidenteel zal het op deze wijze verwerken u ook veel klikken besparen.

Correcties maken

Een nieuw pull request zal automatisch worden toegevoegd aan de lijst met Pull requests. Andere bewerkers en beheerders zullen uw pull request nakijken en zij maken suggesties of vragen om correcties te maken.

Een pull request zal ook geautomatiseerde controles voor het bouwen activeren (bijv, voor opmaak van rst, syntaxis voor code van Python), en rapportage wordt aan de onderzijde van de pagina weergegeven. Als een fout wordt gevonden zal een rood kruis naast uw commit verschijnen. Klik op het rode kruis of op Details in het overzichtsgedeelte aan de onderzijde van de pagina, om de details van de fout te zien. U zult elke gerapporteerde fout of waarschuwing moeten repareren vóórdat uw wijzigingen worden doorgevoerd naar de opslagplaats qgis/QGIS-Documentation.

U kunt aanpassingen aan uw pull request maken totdat het is samengevoegd met de hoofdopslagplaats, ofwel om uw request te verbeteren, of gevraagde aanpassingen uit te voeren, of om een fout bij het bouwen op te lossen.

Klik, om wijzigingen te maken, op de tab githubFilesChanged op de pagina van uw pull request en klik op de knop met het potlood githubEditPencil naast de bestandsnaam die u wilt aanpassen.

Aanvullende wijzigingen zullen automatisch worden toegevoegd aan uw pull request als u deze wijzigingen maakt voor dezelfde branch als die welke u heeft ingediend in uw pull request. U zou, om deze reden, dan ook slechts aanvullende wijzigingen moeten maken als die wijzigingen een relatie hebben met het probleem dat u van plan bent op te lossen met dat pull request.

Wanneer u een ander probleem wilt oplossen, maak dan een nieuwe branch aan voor die wijzigingen en herhaal bovenstaande stappen.

Een beheerder zal uw bijdrage samenvoegen nadat eventuele bouwfouten zijn gecorrigeerd, en nadat u en de beheerder tevreden zijn met uw wijzigingen.

1.1.5. Uw samengevoegde branch verwijderen

U kunt de branch verwijderen nadat uw wijzigingen zijn samengevoegd. Verwijderen van oude branches helpt u bij het voorkomen van ongebruikte en gedateerde branches in uw opslagplaats.

  1. Navigeer naar uw fork van de opslagplaats van QGIS-Documentation (https://github.com/<YourName>/QGIS-Documentation)

  2. Klik op de tab Branches. Onder Your branches zult u een lijst zien van al uw branches.

  3. Klik op het pictogram deleteSelected Delete this branch om ongewenste branches te verwijderen.

1.2. Gereedschappen voor de opdrachtregel van Git gebruiken

De webinterface GitHub is een gemakkelijke manier om de opslagplaats van de QGIS-documentation bij te werken met uw bijdragen, maar het biedt geen gereedschappen om:

  • uw commits te groeperen en de geschiedenis van uw wijzigingen op te schonen

  • mogelijke conflicten met de hoofdopslagplaats op te lossen

  • de documentatie te bouwen om uw wijzigingen te testen

U dient git te installeren op uw harde schijf om toegang te verkrijgen tot meer geavanceerde en krachtige programma’s en een lokale kopie van de opslagplaats te krijgen. Sommige basisbeginselen die u vaak nodig heeft worden hieronder besproken. U vindt daar ook regels die u in acht zou moeten nemen, zelfs als u slechts opteert voor de webinterface.

In de voorbeelden van code hieronder, geven lijnen die beginnen met $ opdrachten weer die u zou moeten typen, terwijl # opmerkingen zijn.

1.2.1. Lokale opslagplaats

Nu bent u klaar om een lokale kloon van uw opslagplaats QGIS-Documentation op te halen.

U kunt uw opslagplaats voor QGIS met de URL van het web als volgt klonen:

# move to the folder in which you intend to store the local repository
$ cd ~/Documents/Development/QGIS/
$ git clone https://github.com/<YourName>/QGIS-Documentation.git

De eerdere opdrachtregel is slechts een voorbeeld. U zou zowel het pad als de URL voor de opslagplaats moeten aanpassen, waarbij <YourName> wordt vervangen door uw gebruikersnaam.

Controleer het volgende:

# Enter the local repository
$ cd ./QGIS-Documentation
$ git remote -v
origin  https://github.com/<YourName>/QGIS-Documentation.git (fetch)
origin  https://github.com/<YourName>/QGIS-Documentation.git (push)
$ git branch
* master
  • origin is de naam van de opslagplaats op afstand van uw opslagplaats voor QGIS-Documentation.

  • master is de standaard hoofdbranch. U zou die nooit moeten gebruiken om iets in te dienen! Nooit!

Als alternatief kunt u uw opslagplaats voor QGIS klonen met het protocol voor SSH:

# move to the folder in which you intend to store the local repository
$ cd ~/Documents/Development/QGIS/
$ git clone [email protected]:<YourName>/QGIS-Documentation.git

Tip

Permission denied (publickey) error?

Indien u een fout Permission denied (publickey) error krijgt met de eerdere opdracht, zou er een probleem kunnen zijn met uw sleutel voor SSH. Bekijk GitHub help voor de details.

Controleer het volgende als u het protocol voor SSH gebruikte:

# Enter the local repository
$ cd ./QGIS-Documentation
$ git remote -v
origin  [email protected]:<YourName>/QGIS-Documentation.git (fetch)
origin  [email protected]:<YourName>/QGIS-Documentation.git (push)
$ git branch
* master

U zou hier kunnen beginnen te werken, maar op de lange termijn zou u veel problemen krijgen wanneer u uw bijdragen (Pull Request genaamd in het proces in Github) wilt indienen omdat de hoofdbranch van de opslagplaats van qgis/QGIS-Documentation af zal wijken van uw lokale opslagplaats of uw opslagplaats op afstand. U dient dan de hoofdopslag op afstand in de gaten te houden en te werken met branches.

1.2.2. Een andere opslagplaats op afstand toevoegen

Voeg een nieuwe opslagplaats op afstand toe aan uw lokale opslagplaats om in staat te zijn het werk in het hoofdproject te volgen. Deze nieuwe opslagplaats op afstand is de opslagplaats QGIS-Documentation van het project QGIS:

$ git remote add upstream https://github.com/qgis/QGIS-Documentation.git
$ git remote -v
origin  https://github.com/<YourName>/QGIS-Documentation.git (fetch)
origin  https://github.com/<YourName>/QGIS-Documentation.git (push)
upstream        https://github.com/qgis/QGIS-Documentation.git (fetch)
upstream        https://github.com/qgis/QGIS-Documentation.git (push)

U kunt op soortgelijke wijze het protocol voor SSH gebruiken om een opslagplaats op afstand toe te voegen aan uw lokale opslagplaats:

$ git remote add upstream [email protected]:qgis/QGIS-Documentation.git
$ git remote -v
origin  [email protected]:<YourName>/QGIS-Documentation.git (fetch)
origin  [email protected]:<YourName>/QGIS-Documentation.git (push)
upstream        [email protected]:qgis/QGIS-Documentation.git (fetch)
upstream        [email protected]:qgis/QGIS-Documentation.git (push)

U heeft nu dus de keuze tussen twee opslagplaatsen op afstand:

  • origin om uw lokale branch door te voeren in uw opslagplaats op afstand

  • upstream om uw bijdragen samen te voegen (als u daar de rechten voor heeft) met de officiële OF om uw hoofdbranch van uw lokale opslagplaats bij te werken vanuit de hoofdbranch van de officiële opslagplaats.

Notitie

upstream is slechts een label, een soort standaard naam, maar u mag het noemen zoals u wilt.

1.2.3. Uw basisbranch bijwerken

Vóórdat u gaat werken aan een nieuwe bijdrage zou u altijd de lokale hoofdbranch in uw lokale opslagplaats moeten bijwerken. Er van uitgaande dat u van plan bent wijzigingen door te sturen naar de documentatie voor testen, voer de volgende opdrachtregels uit:

# switch to master branch (it is easy to forget this step!)
$ git checkout master
# get "information" from the master branch in the upstream repository
# (aka qgis/QGIS-Documentation's repository)
$ git fetch upstream master
# merge update from upstream/master to the current local branch
# (which should be master, see step 1)
$ git merge upstream/master
# update **your** remote repository (aka <YourName>/QGIS-Documentation)
$ git push origin master

Nu heeft u uw lokale opslagplaats en een op afstand die beide hun branch master hebben die up to date is met de officiële branch master van QGIS-Documentation. U kunt nu aan uw bijdrage gaan werken.

Notitie

Schakel naar de branch als u wilt bijdragen aan uitgebrachte documentatie

Naast de documentatie voor testen, gaan we ook door met het oplossen van problemen in de laatste uitgave, wat betekent dat u ook daaraan kunt bijdragen. Als we de voorbeeldcode uit het eerdere gedeelte volgen, vervang``master`` door de corresponderende branch van de laatste documentatie.

1.2.4. Aan uw branch voor productie bijdragen

Nu uw basisbranch is bijgewerkt, dient u een toegewezen branch te maken waarin u uw bijdragen toevoegt. Werk altijd met een andere branch dan de basisbranch! Altijd!

# Create a new branch
$ git checkout -b myNewBranch
# checkout means go to the branch
# and -b flag creates a new branch if needed, based on current branch
# Let's check the list of existing branches (* indicates the current branch)
$ git branch
master
release_2.18
...
* myNewBranch
# You can now add your contribution, by editing the concerned file(s)
# with any application (in this case, vim is used)
$ vim myFile
# once done
$ git add myFile
$ git commit

Enkele woorden over opdrachten om in te dienen/pushen:

  • probeer slechts één bijdrage tegelijk in te dienen (atomic change) d.i. heeft betrekking op één probleem

  • probeer in de titel en beschrijving van uw indiening zorgvuldig uit te leggen wat u gewijzigd hebt. De eerste regel is een titel en zou moeten beginnen met een hoofdletter en bestaat uit een lengte van 80 tekens, eindig niet met een .. Wees beknopt. Uw beschrijving mag langer zijn, eindig die met een . en u kunt veel meer details geven.

  • gebruik een # met een getal om naar een probleem te verwijzen. Zet als voorvoegsel Fix als u het ticket repareert: uw indiening zal het ticket sluiten.

Nu uw wijzigingen zijn opgeslagen en doorgevoerd in uw lokale branch, dient u ze door te sturen naar de opslagplaats op afstand om een pull request te maken:

$ git push origin myNewBranch

1.2.5. Uw wijzigingen delen

Nu kunt u naar uw opslagplaats van Github gaan en een Pull Request maken. Controleer dat u een PR maakt vanuit uw branch naar de branch op afstand voor uw doel van de officiële opslagplaats van QGIS-Documentation.

1.2.6. Uw lokale en opslagplaats op afstand opschonen

Nadat uw PR is samengevoegd met de officiële QGIS-Documentation, kunt u uw branch verwijderen. Als u veel op deze manier werkt zult u binnen een paar weken heel veel nutteloze branches hebben. Houd dus uw opslagplaats op de volgende manier schoon:

# delete local branch
$ git branch -d myNewBranch
# Remove your remote myNewBranch by pushing nothing to it
$ git push origin :myNewBranch

En vergeet niet de branch master in uw lokale opslagplaats bij te werken!

1.3. Meer informatie

  • Naast de webinterface Github en het programma git voor de opdrachtregel zoals hierboven vermeld, zijn er ook toepassingen met GUI die u kunt gebruiken om uw bijdragen aan de documentatie te maken en te beheren.

  • Wanneer de wijzigingen in het pull request conflicteren met recente wijzigingen die zijn doorgevoerd in de doel-branch, moeten de conflicten worden opgelost voordat kan worden samengevoegd:

    • als het conflict relateert aan een aantal met elkaar strijdende regels is een knop Resolve conflicts beschikbaar op de pagina van het Github pull request. Druk op de knop en los het probleem op zoals uitgelegd wordt op Resolving a merge conflict on GitHub

    • als het conflict het hernoemen of verwijderen van bestanden betreft, dan dient u het probleem op te lossen met het programma git voor de opdrachtregel. Gewoonlijk moet u eerst uw branch opnieuw als basis instellen boven de doel-branch met de aanroep git rebase targetBranch en de conflicten die worden gerapporteerd oplossen. Lees meer op Resolving a merge conflict using the command line

  • Soms, aan het einde van het proces van proeflezen, zou u kunnen eindigen met wijzigingen die zijn verdeeld over meerdere commits die dat niet noodzakelijkerwijze waard zijn. Git voor de opdrachtregel helpt u deze commits terug te brengen tot een kleiner aantal en meer betekenisvolle berichten voor commits. Enkele details op `Using git rebase on the command line https://docs.github.com/en/get-started/using-git/using-git-rebase-on-the-command-line>`_