Aller au contenu

L'ouverture du code

Comment le code d'Ironlane devient public : dans quel ordre, sous quelle licence, avec quelle gouvernance.

Voir en Markdown

Le cœur et les modules d’Ironlane seront publiés dans un dépôt public, à l’historique neuf. Cette page dit comment, dans quel ordre, et ce qui reste fermé.

  • Un dépôt public neuf, à l’historique neuf. L’historique du dépôt de travail actuel contient des données propres à une société. On ne nettoie pas un historique, on en recommence un.
  • Le cœur et les modules sont publics. Les plugins (tout ce qui est propre à une société ou à un logiciel extérieur) et l’exploitation technique restent hors du dépôt public.
  • Les portes sont publiques et versionnées. C’est le contrat entre le produit et ceux qui l’étendent : voir les plugins.
  • Rien ne part sans contrôle. Chaque publication passe par un contrôle anti-fuite : noms de sociétés et de personnes, adresses IP, références de projet, secrets. Une seule trace bloque la publication.

Le code doit d’abord être prêt, dans cet ordre :

  1. Retirer ce qui est propre à une société : valeurs par défaut, variables, exemples, logos, noms réels dans les données de démonstration.
  2. Sortir les plugins du dépôt du produit : un contrat particulier, un import, un connecteur extérieur deviennent des plugins. Ce qu’ils laissent derrière eux est une porte.
  3. Renommer en une fois : le code passe en anglais, et certains noms du métier changent. Les textes des écrans restent en français. Ce renommage vient avant la publication, parce qu’après, les noms de portes, de tables et de fonctions sont publics, et en changer coûte une version majeure.
  4. Figer les portes dans une première version (api: "1"), avec un banc de compatibilité.

Pas de date : on passe à l’étape suivante quand ses conditions sont réunies.

Étape Ce qui s’ouvre Ce qui reste fermé
0. Préparation (privée) Rien. Installation essayée sur une machine vierge par quelqu’un qui n’a pas écrit le code. Tout
1. Lecture seule Le code, la documentation, la base d’exemple, les portes Tickets, demandes de fusion
2. Signalements Les tickets, les signalements de sécurité privés Le code entrant
3. Bascule Le dépôt public devient le dépôt de travail du propriétaire Les demandes de fusion externes
4. Contributions Les demandes de fusion, avec accord de contribution et relecture par le mainteneur du module Les plugins d’une société
5. Écosystème Le guide d’écriture d’un plugin, un répertoire des plugins, le label partenaire

Chaque nouvelle version publiée est un nouveau commit : l’historique public ne contient que des versions, jamais le détail du travail privé.

Élément Public
Code du cœur et des modules Oui
Base d’exemple, installation, documentation Oui
Format d’import et traducteurs génériques Oui
Portes et leur documentation Oui, avec une politique de versions
Plugins d’une société Jamais, dépôts à part
Exploitation des serveurs, outils de mise en ligne du propriétaire, données Jamais
  • AGPL-3.0, dans son texte original en anglais, seul à faire foi. Elle garantit au client que le code qu’il utilise est lisible et reprenable, et à Ironlane que celui qui héberge une version modifiée la publie.
  • Un accord de contribution (CLA) permet au propriétaire de continuer à distribuer et héberger le produit.
  • Le code est libre ; le nom et le logo ne le sont pas. Un fork peut exister, mais il ne s’appelle pas Ironlane. Une règle d’usage dira ce qu’on peut faire sans demander (« compatible Ironlane », « X pour Ironlane »), ce qui demande un accord et ce qui est refusé.
  • Le modèle économique : le code est libre ; le propriétaire facture l’hébergement, le conseil, la formation, les plugins sur mesure et la certification de partenaires.

Le texte des accords de licence et de marque est en cours de rédaction.

Un fichier de présentation (en anglais et en français), la licence, la liste des licences des dépendances, l’accord de contribution, la règle d’usage de la marque, la politique de sécurité, le guide de contribution, un code de conduite, la gouvernance, la feuille de route, le journal des versions, l’aide, la politique de versions des portes, le guide d’écriture d’un plugin, l’installation et un banc de compatibilité.

  • Le produit suit les versions sémantiques : une majeure peut casser, une mineure ajoute, un correctif corrige.
  • Chaque porte a sa version. L’application refuse de charger un plugin dont la version de porte n’est pas la sienne, avec un message clair. L’ancienne version d’une porte reste servie un temps (à décider : deux versions mineures et au moins six mois).
  • Les migrations ne sont jamais réécrites une fois publiées.
  • Seule la dernière version majeure reçoit les correctifs de sécurité, et la précédente pendant la période de recouvrement.
  • Le propriétaire décide de la direction, des portes et de la marque.
  • Un mainteneur par module, le cœur aussi, relit les demandes qui touchent son module.
  • Pour devenir mainteneur : plusieurs demandes acceptées dans le module, la connaissance de ses règles et l’accord du propriétaire.