Accès direct au contenu Accès direct à la navigation

Ce document développe la façon dont nous gérons les dépôts GIT de nos paquets.
Pour plus d’information sur GIT, voyez le site http://git-scm.com/.
Pour plus d’information sur GitHub, voyez le site http://github.com/about.
Pour une liste de nos dépôts sur GitHub, voyez l’adresse http://github.com/atelierspierrot.

Architecture générale

Tout nos paquets sont développés sous le logiciel de contrôle de version GIT, sur un dépôt hébergé sur GitHub. De cette façon, toutes mise à jour peut être suivie sur une ligne de temps et il est possible de revenir à une ancienne version si nécessaire.

Tout nos dépôts suivent l’architecture suivante :

  • la branche "master" : c’est la branche principale du dépôt et la version stable actuelle du paquet ; elle n’INCLUT PAS la documentation (e cas échéant) et est la branche utilisée par défaut sur "Packagist" ;
  • la branche "dev" : c’est un mirroir de la branche "master" pour les développements ; elle peut parfois contenir quelques commits qui ne sont pas encore "mergés" sur la branche "master" (mais avec des évolutions testées) et INCLUT la documentation ; dans certains cas, elle inclut également des outils de construction ;
  • la branche "wip" : c’est la branche de développement de nos paquets ; elle embarque presque toujours des commits qui ne sont pas encore sur le "master" (évolutions non encore testées) ; c’est l’espace de travail de nos dépôts, qui ne DOIT PAS être utilisé dans des projets externes.

Versionnement

Nous essayons de suivre les règles de Versionnement Sémantique pour construire nos références de publication. Cela implique que nous construisons le nom de nos "releases" en suivant le masque X.Y.Z(-status), avec :

  • X le numéro de version majeure ; il ne change que lorsque l’API du paquet présente des modifications significatives ;
  • Y le numéro de version mineur ; il est incrémenté pour chaque version majeure dès lors que les nouveautés ne sont pas une simple correction de bug ;
  • Z est la référence de correction de bug ; elle ne doit changer que lorsqu’un bug a été identifié et fixé ; ces évolutions DOIVENT être rattachées à un ticket de bug ;
  • le status informe le plus souvent sur l’état d’une "pré-release" : alpha, beta etc ; il est fixé sur dev pour nos branches de développement (comme les branches wip développées plus haut).

Open-Source & Communauté

Nos travaus sont des logiciels gratuits, le plus souvent proposés sous une Licence Publique Générale version 3.0 ; vous pouvez librement les utiliser, pour vous-même ou un usage commercial, en modifier le code source pour vos propres besoins, re-distribure librement vos travaux ou les porposer à la communauté, tant que vous conservez les informations sur leurs auteurs initiaux.

Les sources étant hébergées sur des dépôts GIT par GitHub, vous pouvez les modifier, pour améliorer une caractéristique ou corriger une erreur, en créant votre propre "fork" du dépôt, le modifiant puis demander de "merger" vos modifications sur la branche originale.

Veuillez noter que la branche "master" est toujours la dernière version stable du code. Les développements sont faits sur les branches "dev" et "wip" et vous pouvez créer vos propres branches pour vos développements.