Contribuer

Merci de prendre le temps de contribuer au Design System, c’est de cette manière qu’il va pouvoir évoluer et s’adapter aux différents besoins des équipes et des projets.

Rapport de bug

Lorsque vous constatez un bug dans l’un des packages du Design System, vous pouvez créer un rapport de bug pour notifier l’équipe de celui-ci.

Avant d’ouvrir un nouveau rapport de bug, vérifiez :

• Qu’un rapport similaire n’ait pas déjà été ouvert en cherchant dans les rapports existants
• Que le bug est toujours présent dans la dernière version du package concerné

Une fois ces vérifications effectuées, vous pouvez créer un rapport de bug. Lors de l’écriture de votre rapport de bug, essayez de donner le plus de détails possible.

Documentation

Pour modifier la documentation, vous pouvez simplement suivre le lien « Éditer cette page sur GitHub » présent en bas de page, celui-ci ouvrira l’éditeur en ligne de Github, vous permettant d’éditer directement la documentation, puis de créer une nouvelle branche afin de proposer vos modifications via une Pull Request.

Développement

Notre Design System est un monorepo utilisant lerna qui rassemble notre librairie de composants, notre Starter Kit ainsi que notre documentation et les composants plus macros, ce qui permet de réduire le coût de travailler sur plusieurs projets à la fois.

Configuration de votre environnement

Vous devez installer les outils suivants :

• Git >v2.20
• Node.js LTS
• Yarn

Certaines de nos dépendances ont besoin de node-gyp pour fonctionner. Vous n’avez pas besoin d’installer node-gyp directement, mais vous pouvez avoir besoin d’outils supplémentaires, en particulier sur Windows. Consultez la documentation de node-gyp pour plus de détails.

Une fois les outils installés, vous pouvez cloner le repo :

git clone git@github.com:assurance-maladie-digital/design-system.git

git clone https://github.com/assurance-maladie-digital/design-system.git

Ensuite, vous devez installer les dépendances :

# Allez dans le dossier design-system
cd design-system

# Installez toutes les dépendances
yarn

Finalement, vous devez compiler une première fois les librairies :

# Compilez toutes les librairies
yarn build

Une fois ces étapes effectuées, vous êtes prêt à développer !

"@cnamts/vue-cli-plugin-vue-dash": {
	"version": "/full/path/to/plugin/"
}

yarn add --dev file:/full/path/to/plugin

npm install --save-dev file:/full/path/to/plugin

vue invoke @cnamts/vue-dash

vue invoke @cnamts/vue-dash -- --render-template

Commits

Les messages de commit doivent suivre la convention <gitmoji> <scope>: <message>, par exemple :

✨ vue-dot: Add DatePicker

🐛 vue-dash: Fix missing data-cy attributes

Règles générales

Les messages de commit doivent :

• Être écrits en Anglais
• Commencer avec un Gitmoji correspondant au type de changement
• Commencer avec une majuscule
• Ne pas terminer avec un point
• Utiliser le mode impératif
• Commencer avec un verbe (comme Add, Fix, Update, Refactor, …)

Pull Requests

Pour créer une nouvelle branche et effectuer des modifications, vous pouvez faire une demande à l’équipe pour vous donner les droits d’écriture sur le projet, ou vous pouvez créer un fork du repo design-system.

Et ensuite ajouter votre fork comme remote :

git remote add fork git@github.com:USERNAME/design-system.git

git remote add fork https://github.com/USERNAME/design-system.git

Vous pouvez maintenant créer une nouvelle branche sur laquelle travailler, puis commiter vos changements et pousser votre branche en exécutant la commande git push -u ou git push -u fork si vous avez créé un fork.

Enfin, vous pouvez créer une Pull Request en suivant et en complétant le template.