Guide du contributeur

Bienvenue

Victoire est un projet open-source, orienté vers la communauté. Nous sommes toujours heureux de recevoir votre participation au développement du produit et toute aide est bienvenue, quelque soit votre niveau de maîtrise et serons très heureux de vous compter parmi la liste de nos chers contributeurs

Gestion de projet

Nous utilisons le système natif d’Issues de github mais nous suivons quelques conventions:

• une issue doit être priorisée:
  • Priority : Low
  • Priority : Medium
  • Priority : High
• une issue doit être catégorisée:
  • Type : Bug
  • Type : Feature
  • Type : Technical debt

Les tags contextuels commencent par le caractère ~ (tilde), utilisez-les à votre convenance.

Pour une meilleure visibilité sur les différentes tâches liées à l’écosystème Victoire, nous utilisons Waffle, allez jeter un petit coup d’oeil !

Poser une question

Vous pouvez posez vos questions et suivre celles liées à Victoire sur StackOverflow

Commencer tranquillement

Si vous voulez aider mais que vous ne savez pas trop quelle tâche prendre, vous serez surement contents d’apprendre qu’il existe un tag contextuel recensant les tâches faisable sans d’expérience particulière sur Victoire, il s’agit des ~EasyPick

Workflow

Version Majeure

Lors de l’évolution de l’API externe de Victoire, notamment au niveau des Widgets et des BusinessEntities, un incrémentation majeur sera effectuée => X.0.0. Dans le cas des Widgets, une incrémentation majeur implique des changements à opérer dans chaque widget. Ceux-ci subieront eux aussi une incrémentation de leurs version majeure => X.0.0.

Version mineure

L’équipe Core de Victoire travaille sur le ou les prochains Milestones et effectue ses Pull Request vers la branche master. Quand ces développements seront finalisés, une version mineure sera tagguée => 1.X.0.

Patche

Toute nouvelle fonctionnalité, amélioration ou correctif développé en dehors d’un milestone, par la communauté ou par l’équipe CORE doit faire l’objet d’une Pull Request vers les branches supportées, la branche la plus récente et la LTS le cas échéant. Une version de patch sera alors tagguée => 0.0.X. Ces modifications seront récupérées lors de la création de la release mineure suivante => 1.X.0.

Road Map

Victoire étant un DCMS Open Source cela signifie qu’il est gratuit et que tout le monde peut avoir accès au code source et le modifier. De cette façon, notre CMS se base sur une importante communauté de développeurs et d’utilisateurs qui font évoluer le logiciel grâce à l’addition de nouveaux modules.

Pour permettre aux utilisateurs et / ou contributeurs d’avoir une vision de l’état d’avancement de Victoire, nous mettons à disposition une road map chargée de détailler les futures fonctionnalités prévues ainsi que les mises à jour - regroupées dans un planning.

Si des dépendances de Composer sont modifiées, ajouter une note dans le fichier composer.md.

Nouvelle release

CHANGELOG.md

Pour la génération du fichier CHANGELOG.md, nous utilisons le repo skywinder/github-changelog-generator.

• Créez-vous un token et récupérez-le
• mettez-à jour le fichier en exécutant cette commande

github_changelog_generator -t YOURTOKEN --future-release X.Y.Z

UPGRADE-X.Y.md

Le fichier UPGRADE-X.Y.md permet de connaitre les opérations à effectuer afin de mettre à jour un projet. Toute nouvelle version majeure et mineur doit logiquement faire l’objet de création ou d’ajout dans ce fichier.