Maak bijdragen gemakkelijk
Om betere, betrouwbaardere en rijkere software te ontwikkelen, moeten gebruikers in staat zijn om problemen op te lossen, functies toe te voegen en beveiligingsproblemen van de gedeelde codebase aan te pakken.
Een gedeelde digitale infrastructuur maakt het gemakkelijker om samen te werken aan bijdragen. Hoe minder moeite het kost om bijdragen te leveren die door de codebase worden geaccepteerd, hoe groter de kans dat gebruikers bijdragers worden.
Vereisten
- De codebase MOET een openbaar issuetracker hebben die suggesties van iedereen accepteert.
- De documentatie MOET zowel naar de openbare issuetracker als naar ingediende wijzigingen in de codebase verwijzen, bijvoorbeeld in een
README-bestand. - De codebase MOET communicatiekanalen hebben voor gebruikers en ontwikkelaars, bijvoorbeeld e-maillijsten.
- Er MOET een manier zijn om beveiligingsproblemen te melden voor verantwoorde openbaarmaking via een gesloten kanaal.
- De documentatie MOET instructies bevatten over hoe mogelijk beveiligingsgevoelige problemen kunnen worden gemeld.
Quickscan
- Bevestig dat er een openbare issuetracker is.
- Bevestig dat de codebase links bevat naar de openbare issuetracker en ingediende wijzigingen in de codebase.
- Bevestig dat het mogelijk is om deel te nemen aan een discussie met andere gebruikers en ontwikkelaars over de software via de kanalen die in de codebase worden beschreven.
- Bevestig dat er een gesloten kanaal is voor het melden van beveiligingsproblemen.
- Bevestig dat er instructies zijn voor het privé melden van beveiligingsproblemen.
Aanwijzingen voor beleidsmakers
- Houd beleidskwesties bij in de codebase, zodat een relevante externe beleidsexpert hulp kan aanbieden.
Aanwijzingen voor managers
- Houd beheerskwesties bij in de codebase, zodat externe managers met relevante ervaring hulp kunnen aanbieden.
- Ondersteun je ervaren beleidsmakers, ontwikkelaars en ontwerpers om zo lang mogelijk bij te blijven dragen aan de codebase.
Aanwijzingen voor ontwikkelaars en ontwerpers
- Net als bij beoordelingen, zorg ervoor dat je snel reageert op verzoeken.
- Houd je managers op de hoogte van de tijd en middelen die je nodig hebt om andere bijdragers te ondersteunen.
- Zorg ervoor dat geschikte communicatiekanalen voor het stellen van vragen aan beheerders en belanghebbenden gemakkelijk te vinden zijn, bijvoorbeeld in de README.
- Zorg ervoor dat de juiste contactgegevens zijn opgenomen in de metadata, bijvoorbeeld in het publiccode.yml-bestand.
Meer informatie
- Hoe uitzonderlijke bijdragen aan je open-sourceproject te inspireren door Joel Hans.
- De voordelen van coderen in het openbaar door de UK Government Digital Service.