Contribuer

Exigences système

Avant de travailler sur Ubiquity, ajoutez à votre environnement la configuration suivante :

  • Git

  • PHP 7.1 ou plus.

Télécharger le code source Ubiquity

Sur le repository github Ubiquity :

  • Forkez le projet Ubiquity

  • Clonez votre fork localement

git clone git@github.com:USERNAME/ubiquity.git

Travaillez sur votre partie

Note

Avant de commencer, vous devez savoir que tous les correctifs que vous allez soumettre doivent être publiés sous la licence Apache 2.0, sauf si cela est explicitement spécifié dans vos commits.

Créez une branche dédiée

Note

Utilisez un nom descriptif pour la nommer :

  • issue_xxx où xxx est le numéro de l’issue est une bonne convention pour les corrections de bugs.

  • feature_name est une bonne convention pour les nouvelles fonctionnalités

git checkout -b NEW_BRANCH_NAME master

Travaillez sur votre partie

Travaillez sur votre code et commitez aussi souvent que nécessaire, en gardant à l’esprit les éléments suivants :

  • Lire la partie Ubiquity coding standards;

  • Ajoutez des tests unitaires, fonctionnels ou d’acceptation pour prouver que le bug est corrigé ou que la nouvelle fonctionnalité fonctionne réellement ;

  • Faites des commits atomiques et logiquement séparés (utilisez git rebase pour avoir un historique propre et logique) ;

  • Rédigez de bons messages de commit (voir le conseil ci-dessous).

  • Incrémentez les numéros de version dans tous les fichiers modifiés, en respectant les règles semver :

    Étant donné un numéro de version MAJOR.MINOR.PATCH, incrémenter le :

    • La partie MAJOR si des changements non rétro compatibles sont effectués sur l’API,

    • la partie MINOR lorsque vous ajoutez des fonctionnalités de manière rétrocompatible, et

    • la partie PATCH lorsque vous effectuez des corrections de bugs ou des améliorations rétro compatibles.

Soumettez vos modifications

Mettez à jour la partie [Unrelease] du fichier CHANGELOG.md en intégrant vos modifications dans les parties appropriées :

  • Added

  • Changed

  • Removed

  • Fixed

Avant de soumettre votre patch, mettez à jour votre branche (nécessaire si vous mettez du temps à terminer vos modifications) :

git checkout master
git fetch upstream
git merge upstream/master
git checkout NEW_BRANCH_NAME
git rebase master

Faire une Pull Request

Vous pouvez maintenant faire une Pull Request sur le repository github Ubiquity .