Help me een onboarding gids voor GitHub repository voor nieuwe bijdragers maken
description
Het creëren van een onboarding gids stroomlijnt het bijdrageproces, verbetert de samenwerking en verbetert de ervaring voor nieuwe bijdragers, wat uiteindelijk leidt tot een actievere en meer betrokken gemeenschap.
prompt
try_prompt
Ik wil een uitgebreide onboarding gids maken voor nieuwe bijdragers aan mijn GitHub repository met de volgende details: Repository naam: {{repository_naam}}. Huidige documentatiestatus: {{documentatie_status}}. Specifi ... more
generate_helper
...
tags
ai_answers
provider: openai
model: gpt-4.1-nano
Natuurlijk! Hier is een uitgebreid advies voor het structureren en schrijven van je onboarding gids voor nieuwe bijdragers aan je GitHub repository 'voorbeeld-repo', inclusief tips voor duidelijkheid en inclusiviteit.
**Structuur van de onboarding gids**
1. **Introductie**
- Welkom en doel van de gids
- Kort overzicht van 'voorbeeld-repo'
- Belang van bijdragen en community
2. **Repository overzicht**
- Wat doet de repository?
- Belangrijke onderdelen en structuur van de code
- Richtlijnen en code van conduct (indien aanwezig)
3. **Hoe je kunt bijdragen**
- Algemene procedures voor bijdragen
- Voorwaarden en verwachtingen
4. **Stapsgewijze handleiding voor het indienen van een pull request (PR)**
- Voorbereiding
- Forken van de repository
- Clonen van de fork naar je lokale machine
- Aanmaken van een nieuwe branch
- Aanpassingen maken
- Code wijzigingen
- Testen en documentatie updates
- Het indienen van de PR
- Pushen van de wijzigingen naar je fork
- Een pull request openen naar 'voorbeeld-repo'
- Beschrijven van veranderingen en het toevoegen van relevante labels of verzoeken
5. **Tips en beste praktijken**
- Schrijf duidelijke commitberichten
- Houd je PR klein en gericht
- Reageer op feedback
6. **Veelgestelde vragen (FAQ)**
- Mogelijke problemen en oplossingen
- Contactinformatie voor ondersteuning
7. **Inclusiviteit en community**
- Aanmoedigen van diverse bijdragen
- Respectvolle communicatie
- Hoe je vragen kunt stellen en feedback kunt geven
---
**Advies voor duidelijkheid en toegankelijkheid**
- Gebruik eenvoudige en duidelijke taal.
- Voeg visuele hulpmiddelen toe (screenshots, diagrammen) voor complexe stappen.
- Maak gebruik van bullet points, genummerde lijsten en koppen om de informatie overzichtelijk te maken.
- Link naar gerelateerde bronnen of documentatie binnen je project.
- Overweeg het opnemen van korte video tutorials voor visuele ondersteuning.
**Bevorderen van een inclusieve omgeving**
- Vermijd jargon of leg het uit indien nodig.
- Moedig bijdragen van mensen met verschillende achtergronden aan.
- Vermeld dat alle niveaus van ervaring welkom zijn.
- Geef duidelijke instructies over hoe vragen en feedback kunnen worden ontvangen en beantwoord.
- Zorg voor een vriendelijke en open toon in de tekst.
---
**Voorbeeld structuur in tekst**
```markdown
# Welkom bij de onboarding gids voor 'voorbeeld-repo'
## Introductie
Welkom! Deze gids helpt je om snel en gemakkelijk bij te dragen aan 'voorbeeld-repo'. Jouw bijdrages maken een verschil!
## Overzicht van de repository
Hier vind je een korte uitleg over wat de repository doet en hoe deze is opgebouwd.
## Hoe je een pull request indient
Volg deze stappen:
1. Fork de repository
2. Clone je fork naar je computer
3. Maak een nieuwe branch: `git checkout -b mijn-verbetering`
4. Voer je wijzigingen door
5. Test je wijzigingen
6. Push je branch: `git push origin mijn-verbetering`
7. Open een pull request via GitHub, beschrijf de veranderingen duidelijk
## Tips
- Schrijf duidelijke commitberichten
- Houd je PR klein en overzichtelijk
- Reageer snel op feedback
## Vraag hulp
Heb je vragen? Neem contact op via [e-mailadres/issue tracker].
## Inclusiviteit
Iedereen is welkom! Respecteer elkaar en draag bij aan een positieve community.
```
Door deze structuur en tips toe te passen, creëer je een duidelijke, toegankelijke en inclusieve onboarding gids die nieuwe bijdragers enthousiasmeert en ondersteunt.
provider: deepseek
model: deepseek-chat
Zeker! Hier is een uitgebreide onboardinggids voor nieuwe bijdragers aan je GitHub repository, opgesteld in het Nederlands met aandacht voor structuur, duidelijkheid en inclusiviteit.
---
### **Onboardinggids voor Nieuwe Bijdragers - `voorbeeld-repo`**
Welkom bij de community rond `voorbeeld-repo`! We waarderen je interesse en zijn blij dat je wilt bijdragen. Deze gids helpt je om snel aan de slag te gaan, of je nu een beginner of een ervaren ontwikkelaar bent. Ons doel is om een duidelijke, ondersteunende en inclusieve omgeving te bieden waar iedereen met respect wordt behandeld.
---
#### **1. Eerste Stappen**
- **Verken de Repository**: Bekijk eerst de `README.md` en de bestaande documentatie (in opbouw) om een beeld te krijgen van het project.
- **Stel Vragen**: Twijfel je ergens over? Gebruik de *Discussions*-tab of open een *Issue* op GitHub. Geen vraag is te simpel!
- **Communityrichtlijnen**: Lees onze *Code of Conduct* (gedragscode) om te zorgen dat we samen een positieve en respectvolle sfeer behouden.
---
#### **2. Hoe Draag Je Bij?**
We moedigen bijdragen aan in alle vormen, zoals:
- Bugfixes of verbeteringen.
- Nieuwe functies voorstellen of toevoegen.
- Documentatie verbeteren (zoals deze gids!).
- Andere leden helpen in discussies.
---
#### **3. Een Pull Request (PR) Indienen – Stapsgewijze Uitleg**
Volg deze stappen om een wijziging voor te stellen:
1. **Fork de Repository**
Klik op de "Fork"-knop rechtsboven om een kopie van `voorbeeld-repo` naar je eigen GitHub-account te maken.
2. **Kloon je Fork**
Gebruik deze commando’s om de code lokaal te werken:
```bash
git clone https://github.com/jouw-gebruikersnaam/voorbeeld-repo.git
cd voorbeeld-repo
```
3. **Maak een Branch aan**
Werk nooit direct in de `main`-branch. Gebruik een beschrijvende branchnaam:
```bash
git checkout -b feature/jouw-wijziging
```
4. **Voer je Wijzigingen Uit**
Pas code of documentatie aan en test je wijzigingen lokaal. Voeg comments toe waar nodig voor duidelijkheid.
5. **Commit je Wijzigingen**
Schrijf duidelijke commit-berichten:
```bash
git add .
git commit -m "Beschrijf kort wat je hebt toegevoegd of opgelost"
```
6. **Push naar je Fork**
```bash
git push origin feature/jouw-wijziging
```
7. **Open een Pull Request**
- Ga naar de oorspronkelijke `voorbeeld-repo` op GitHub.
- Klik op *Pull Requests* → *New Pull Request*.
- Selecteer je branch en beschrijf:
- **Wat je hebt gewijzigd** en **waarom**.
- Of je code getest is.
- Referenties naar gerelateerde Issues (bijv. `Fix #123`).
8. **Reviewproces**
Andere bijdragers reviewen je PR. Wees open voor feedback en pas zo nodig aan. Zodra alles goedgekeurd is, mergen we je bijdrage!
---
#### **4. Tips voor Succesvolle Bijdragen**
- **Begin Klein**: Kies een *good first issue* (gelabeld in Issues) om vertrouwd te raken.
- **Communicatie is Key**: Vraag om hulp bij onduidelijkheden via Issues of Discussions.
- **Wees Geduldig**: Reviews kunnen even duren; we werken vaak in onze vrije tijd.
---
#### **5. Een Inclusieve Omgeving**
- **Iedereen is Welkom**: We waarderen diversiteit in achtergrond, ervaring en perspectieven.
- **Respectvolle Taal**: Gebruik inclusieve taal (bijv. "zij/hun" in plaats van aannames).
- **Feedback op Bouwen**: Geef constructieve feedback en focus op ideeën, niet op personen.
---
#### **6. Hulp Nodig?**
- Raadpleeg eerst bestaande documentatie (zoals deze gids).
- Zoek in *Issues* of je vraag al gesteld is.
- Neem contact op met maintainers via GitHub of e-mail (voeg contactgegevens toe indien van toepassing).
---
**Bedankt voor je bijdrage!** Samen maken we `voorbeeld-repo` beter. 🚀
---
### **Advies voor jou als Maintainer**
- **Houd de Gids Levend**: Update de gids regelmatig bij wijzigingen in het project.
- **Label Issues**: Gebruik labels zoals `good first issue` om beginners te helpen.
- **Wees Toegankelijk**: Reageer tijdig op PR’s en vragen om betrokkenheid te stimuleren.
- **Four Code of Conduct**: Zorg dat deze zichtbaar is en handhaaf deze consistent.
Laat het weten als je hulp nodig hebt bij het toevoegen van specifieke secties of het vertalen van onderdelen!

