Maak bijdragen gemakkelijk
Om betere, betrouwbaardere en functierijke software te ontwikkelen, moeten gebruikers problemen kunnen oplossen, functies kunnen toevoegen en beveiligingsproblemen van de gedeelde codebase kunnen aanpakken.
Een gedeelde digitale infrastructuur maakt het makkelijker om samen te werken. Hoe minder moeite het kost om bijdragen te leveren die door de codebase worden geaccepteerd, hoe groter de kans dat gebruikers ook bijdragen gaan leveren.
Vereisten
-
De codebase MOET een openbare issue tracker hebben die suggesties van iedereen accepteert.
-
De documentatie MOET linken naar zowel de openbare issue tracker als de ingediende codebase-wijzigingen, 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 kunnen rapporteren voor verantwoorde openbaarmaking via een gesloten kanaal.
-
De documentatie MOET instructies bevatten voor het melden van potentieel veiligheidsgevoelige problemen.
Hoe te testen
-
Controleer of er een openbare issue tracker is.
-
Controleer of de codebase links bevat naar de openbare issue tracker en ingediende wijzigingen in de codebase.
-
Controleer of het mogelijk is om met andere gebruikers en ontwikkelaars deel te nemen aan een discussie over de software via de kanalen die in de codebase worden beschreven.
-
Controleer of er een gesloten kanaal is voor het melden van beveiligingsproblemen.
-
Controleer of er instructies zijn voor het privé melden van beveiligingsproblemen.
Beleidsmakers in de publieke sector: wat je moet doen
- Houd beleidsissues in de codebase bij, zodat ook externe beleidsexperts vrijwillige hulp kunnen bieden.
Managers: wat je moet doen
-
Houd management issues in de codebase bij, zodat ook externe managers met relevante ervaring vrijwillige hulp kunnen bieden.
-
Stimuleer je ervaren beleidsmakers, ontwikkelaars en ontwerpers om zo lang mogelijk bij te blijven dragen aan de codebase.
Ontwikkelaars en ontwerpers: wat je moet doen
-
Zorg er net als bij reviews voor dat je vlot op verzoeken reageert.
-
Houd je managers op de hoogte van de tijd en middelen die je nodig hebt om andere bijdragers te ondersteunen.
-
Zorg ervoor dat de juiste 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 bestand publiccode.yml.
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.