GGI Activity: Promouvoir les bonnes pratiques de développement open source

Table of contents

Promouvoir les bonnes pratiques de développement open source

Identifiant de l’activité : GGI-A-25.

Description

Cette activité consiste à définir, promouvoir activement et mettre en œuvre les bonnes pratiques open source au sein des équipes de développement.

Comme point de départ, les sujets suivants pourraient faire l’objet d’une attention particulière :

  • Documentation pour les utilisateurs et les développeurs.
  • Organisation correcte du projet sur un dépôt accessible au public.
  • Promouvoir et mettre en œuvre une réutilisation contrôlée.
  • Fournir une documentation complète et à jour du produit.
  • Gestion de la configuration : flux de travail git, modèles de collaboration.
  • Gestion des versions : publier tôt et souvent, des versions stables vs des versions de développement, etc.

Les projets OSS ont un modus operandi particulier, de type bazar. Afin de permettre et d’encourager cette collaboration et cet état d’esprit, certaines pratiques sont recommandées pour faciliter le développement collaboratif et décentralisé et les contributions de développeurs tiers…

Documents communautaires

Assurez-vous que tous les projets au sein de l’entreprise proposent les documents suivants :

  • README - description rapide du projet, comment interagir, liens vers des ressources.
  • Contribuer (« CONTRIBUTING ») - introduction pour les personnes souhaitant contribuer.
  • Code de conduite (« CODE_OF_CONDUCT ») - ce qui est acceptable ou non comme comportement au sein de la communauté.
  • LICENSE - la licence par défaut du référentiel.

Les bonnes pratiques de REUTILISATION

REUSE est une initiative de la Free Software Foundation Europe pour améliorer la réutilisation des logiciels et rationaliser la conformité des licences open source.

Évaluation de l’opportunité

Bien que cela dépende fortement de la connaissance commune du logiciel libre au sein de l’équipe, la formation des personnes et la création de processus qui consolident ces pratiques sont toujours bénéfiques. C’est encore plus important lorsque :

  • les utilisateurs et contributeurs potentiels ne sont pas connus,
  • les développeurs ne sont pas habitués au développement open source.

Suivi de l’avancement

Les points de contrôle suivants montrent une progression de cette Activité :

  • Le projet établit une liste des bonnes pratiques de l’open source à respecter.
  • Le projet surveille son alignement sur les bonnes pratiques.
  • L’équipe de développement a été sensibilisée au respect des bonnes pratiques du logiciel libre.
  • De nouvelles bonnes pratiques sont régulièrement évaluées, et un effort est fait pour les mettre en œuvre.

Outils

Recommandations

  • La liste des bonnes pratiques dépend du contexte et du domaine du programme et devrait être réévaluée régulièrement dans une optique d’amélioration continue. Les pratiques doivent être surveillées et évaluées régulièrement pour suivre les progrès.
  • Former les gens à la réutilisation des logiciels libres (en tant que consommateurs) et aux écosystèmes (en tant que contributeurs).
  • Mettre en œuvre REUSE.software.
  • Mettre en place un processus de gestion des risques juridiques associés à la réutilisation et aux contributions.
  • Encourager explicitement les gens à contribuer à des projets externes.
  • Fournir un modèle ou des directives officielles de structure d’un projet.
  • Mettre en œuvre des vérifications automatisées pour garantir que chaque projet est conforme aux directives.

Ressources

Activités à venir