Vous êtes ici : Communauté

Guide de contribution sur Bitbucket

Les sources du produit K-Sup (socle et extensions) étant en open source (licence Apache 2), les membres de la communauté peuvent contribuer au développement de K-Sup en partageant des corrections d'anomalies ou des évolutions. Ces développements permettent ainsi au produit de correspondre au mieux au besoin métier des utilisateurs avec l'apport de nouvelles fonctionnalités mais aussi de gagner en fiabilité.
Depuis septembre 2016, Kosmos utilise Git comme gestionnaire de sources, couplé à la plate-forme Bitbucket d'Atlassian pour l'hébergement. Les contributions réalisées par les membres de la communauté sont réalisées sous forme de "pull requests" qui seront validées par l'équipe de mainteneurs.

Pré-Requis

Suivi de la demande

Chaque développement doit être lié à un ticket Jira afin de suivre la demande durant sont cycle de vie (spécification, développement, livraison). Le ticket sert aussi de support d'échange avec les membres de la communauté afin de discuter de la pertinence du développement et affiner le besoin avant la réalisation. Si vous identifiez un besoin qui n'est pas déjà présent dans le gestionnaire de tickets, il faut commencer par en saisir un sur la plate-forme d'assistance. Si vous n'avez pas encore de compte pour créer un ticket, vous pouvez en faire la demande sur la page Créez votre compte.

Création de compte Bitbucket

Pour pouvoir contribuer sur la plate-forme, vous devez disposer d'un compte sur Bitbucket : créer un compte.
 

Contribution sur Bitbucket

Initialisation du projet

Les développements doivent être réalisés à partir d'un fork du projet auquel vous souhaitez contribuer.
Pour créer un fork il faut exécuter les actions suivantes à partir du repository du projet :
 
  • Cliquez sur le bouton "+" du menu de gauche
Menu Ajout bitbucket
  • Sélectionnez "Fork this repository"
Fork du repository
  • Renseignez l'écran suivant puis cliquez sur le bouton "Faire un fork du dépôt"
Confimation du fork
 

Développement

Après avoir initialisé votre projet sur Bitbucket, il faut le récupérer sur votre poste de développement. Vous pouvez le faire, soit à partir de votre environnement de développement (IDE) via un plugin utilisant git, soit directement en ligne de commande (git clone).
Afin d'isoler votre contribution du reste du projet il est ensuite nécessaire de créer une branche spécifique. Cette branche de travail doit être nommée de la manière suivante :
  • feature/xxx_label pour les évolutions (avec xxx l'identifiant du ticket et label un descriptif de la branche)
  • bugfix/xxx_label pour les corrections d'anomalies (avec xxx l'identifiant du ticket et label un descriptif de la branche)
Les différents commits que vous allez réaliser doivent avoir un message clair, formé de la manière suivante :
  • Commencer par l'identifiant du ticket Jira (CORE-XXX pour un projet sur le socle par exemple).
  • La première ligne doit résumer ce que comprend le commit.
  • Une description plus complète explique le travail réalisé.
Attention Afin de préserver votre travail, il est important de pousser régulièrement vos développements sur votre repository Bitbucket.


Demande d'intégration au produit

Une fois vos développements finalisés et présents sur Bitbucket, vous pouvez demander l'intégration de votre travail.
Pour cela, vous allez créer une pull request :
  • Dans votre repository sur le menu de gauche, sélectionnez Pull Requests puis Créer une pull request
  • Sur l'écran de création veuillez bien à ce que le repository de destination soit celui du projet initial (préfixé par ksup/)
  • Choisissez la branche vers laquelle vous souhaitez intégrer votre développement
  • Renseignez le champ description afin d'expliquer le travail réalisé.
  • Validez la création en cliquant sur le bouton "Créer une pull request"
Création de pull request

Validation de la contribution

Une fois la pull request créée, l'équipe de mainteneurs de K-Sup analysera la demande. Si celle-ci est validée, votre branche sera intégrée à la branche cible. Si tel n'est pas le cas :
  • soit la demande est estimée incomplète auquel cas une demande de correction vous sera demandée avant une nouvelle validation
  • soit la demande est refusée et le développement ne sera pas intégré au projet K-Sup.