Schrijf documentatie
1. Ga naar GitHub
Open je browser en ga naar github.com/onesteinbv. Controleer of je bent ingelogd met een GitHub-account.
Ga naar github.com/onesteinbv/curq-docs
2. Fork de repository en maak een branch
Klik rechtsboven op Fork (of ga direct naar https://github.com/onesteinbv/curq-docs/fork) om een kopie van de repository naar je eigen GitHub-account te maken. Clone daarna je fork naar je lokale machine. Maak vervolgens een nieuwe branch aan met een duidelijke naam, bijvoorbeeld docs/gebruikershandleiding of docs/fix-typo.
git clone git@github.com:jouwfork/curq-docs.git
3. Kies een onderwerp en schrijf documentatie
Bepaal welk onderwerp je wilt documenteren: bijvoorbeeld een uitleg over een functionaliteit, configuratie-instructies, of een algemeen artikel. De documentatie is geschreven in reStructuredText (.rst) en bevindt zich in de map docs. Let op een duidelijke opbouw, correcte indeling van koppen, en gebruik waar nodig lijsten, codeblokken of tabellen. Volg de stijl van bestaande bestanden om consistentie te behouden.
4. Commit & push
Sla je wijzigingen lokaal op met een duidelijke commit message, zoals "handleiding voor functie x toegevoegd". Push daarna je branch naar je eigen fork op GitHub.
git add . && git commit -m "handleiding voor functie x toegevoegd" && git push
5. Open een PR
Ga naar je fork op GitHub en klik op Compare & pull request. Beschrijf kort wat je hebt toegevoegd of aangepast in de documentatie.