Deze pagina is vertaald door PageTurner AI (beta). Niet officieel goedgekeurd door het project. Een fout gevonden? Probleem melden →
Bijdragen aan documentatie
Wat te veranderen en waarom
Documentatie ontwikkelt zich snel en verandert voortdurend. Denk zorgvuldig na over wat je verandert en waarom: wat draagt het bij voor de toekomst? Grote herschrijvingen en nieuwe pagina's moeten zeer zorgvuldig worden overwogen en afgestemd in onze documentatie Matrix-ruimte.
Zelf nakijken a.u.b.
Voordat je je wijzigingen definitief maakt, wees alsjeblieft zo vriendelijk om ze ten minste door een spellingscontrole (bijv. apsell) en eventueel een grammaticacontrole te halen. AI is hiervoor prima, maar gebruik het spaarzaam voor het genereren van inhoud. Zorg ervoor dat je de uitvoer opnieuw leest en aanpast waar nodig. We waarderen individuele schrijfstijlen, maar het merendeel van onze terugkoppeling gaat over kleine kwesties als deze. Doe dus je best om het meteen goed te doen.
Peer copy-editing
Voor zeer grote wijzigingen raden we peer copy-editing aan. In plaats van een enorme PR in te dienen en dan regel-voor-regel bewerkingen te doen, stellen we voor om je nieuwe of bijgewerkte document in een gezamenlijke editor zoals HackMD te plaatsen en te delen in onze documentatie Matrix-ruimte. Vervolgens kun je via chat en de gezamenlijke editor een regel-voor-regel controle krijgen op spelling, grammatica en opmaak, zonder heen-en-weer in de PR. Als beide partijen tevreden zijn met de wijzigingen, kan er een pull-request worden ingediend.
Hoewel dit als "meer werk" voelt, is dit bij substantiële wijzigingen idealiter maar een klein onderdeel van het proces, en zorgt het voor soepelere eindbeoordelingen.
Peerreviews
Door het volume aan pull-requests in onze documentatierepository en hun uiteenlopende omvang, duurt het beoordelen van sommige PR's lang en kunnen ze daardoor in de vergetelheid raken.
Voor (of direct na) het indienen van je PR voor review, vragen we je een andere PR van iemand anders te vinden (bij voorkeur nog niet beoordeeld) en de wijzigingen grondig door te lezen. Check of ze logisch zijn, of de tekstbewerking goed is, en geef een GitHub-review. Geef waar nodig suggesties voor aanpassingen. Dit helpt enorm om jouw PR beoordeeld te krijgen, want de volgende bijdrager kan dan op zijn beurt jouw PR beoordelen.
Blogberichten
Blogberichten worden uitsluitend door onze teamleden geschreven; we accepteren onder geen enkele omstandigheid externe blogberichten. Blogberichten volgen alle bovenstaande processen en vereisen daarnaast definitieve goedkeuring van het Core-team naast de reguliere documentatiebeoordelaars. Blogberichten kunnen enige tijd in concept- of beoordelingsstatus blijven tot het bijbehorende evenement (bijv. een release); de datum moet altijd de uiteindelijke (verwachte) publicatiedatum weerspiegelen.