GGI Activity: Bevorder best practices voor open source ontwikkeling

Table of contents

Bevorder best practices voor open source ontwikkeling

Activity ID: GGI-A-25.

Beschrijving

Deze activiteit betreft het definiëren, actief bevorderen en implementeren van best practices op het gebied van open source binnen de ontwikkelingsteams.

Als uitgangspunt kunnen de volgende onderwerpen in aanmerking worden genomen:

  • Documentatie voor gebruikers en ontwikkelaars.
  • Correcte organisatie van het project op een publiek toegankelijke repository.
  • Bevorderen en uitvoeren van gecontroleerd hergebruik.
  • Het verstrekken van een volledige en actuele productdocumentatie.
  • Configuratiebeheer: git workflows, samenwerkingspatronen.
  • Releasebeheer: vroeg en vaak uitbrengen, stabiele versus ontwikkelingsversies, enz.

OSS-projecten hebben een speciale, bazaar-achtige modus operandi. Om deze samenwerking en mentaliteit mogelijk te maken en te bevorderen, worden enkele werkwijzen aanbevolen die gezamenlijke en gedecentraliseerde ontwikkeling en bijdragen van externe ontwikkelaars vergemakkelijken…

Gemeenschappelijke documenten

Zorg ervoor dat alle projecten binnen het bedrijf de volgende documenten gebruiken:

  • README – snelle beschrijving van het project, hoe ermee om te gaan, links naar bronnen.
  • Bijdragen – introductie voor mensen die bereid zijn bij te dragen.
  • Gedragscode – Wat is aanvaardbaar – of niet – als gedrag binnen de gemeenschap.
  • LICENSE – de standaard licentie van het archief.

REUSE: Beste praktijken voor REUSE

REUSE is een initiatief van de Free Software Foundation Europe om het hergebruik van software te verbeteren en de compliance van OSS en licenties te stroomlijnen.

Beoordeling van kansen

Hoewel het sterk afhangt van de gemeenschappelijke OSS kennis van het team, is het altijd nuttig om mensen op te leiden en processen te creëren die deze praktijken afdwingen. Het is nog belangrijker wanneer:

  • potentiële gebruikers en medewerkers zijn niet bekend,
  • ontwikkelaars niet gewend zijn aan open source ontwikkeling.

Voortgangsbeoordeling

De volgende verificatiepunten tonen de vooruitgang in deze activiteit aan:

  • Project stelt een lijst op van open source best practices om aan te voldoen.
  • Project bewaakt de afstemming met best practices.
  • Het ontwikkelingsteam heeft bewustzijn opgebouwd over het naleven van best practices voor OSS.
  • Nieuwe best practices worden regelmatig geëvalueerd en er wordt naar gestreefd deze te implementeren.

Hulpmiddelen

Aanbevelingen

  • De lijst met best practices hangt af van de context en het domein van het programma en moet regelmatig opnieuw worden geëvalueerd om continu te verbeteren. De best practices moeten worden gecontroleerd en regelmatig worden beoordeeld om de voortgang te monitoren.
  • Train mensen over OSS hergebruik (als consumenten) en ecosystemen (als bijdragers).
  • Implementeer REUSE.software zoals in activiteit #14.
  • Zet een proces op om de juridische risico’s in verband met hergebruik en bijdragen te beheren.
  • Moedig ensen expliciet aan om bij te dragen aan externe projecten.
  • Zorg voor een sjabloon of officiële richtlijnen voor de projectstructuur.
  • Stel geautomatiseerde controles in om ervoor te zorgen dat alle projecten aan de richtlijnen voldoen.

Middelen

Voorgestelde volgende activiteiten