Skip to content

Guide du développeur

Comment contribuer

NOTE

Ceci est le guide du développeur pour contribuer au projet de cette bibliothèque. Si vous cherchez à utiliser cette bibliothèque, veuillez vous référer au Guide d’utilisation.

TL;DR

Les commits doivent suivre la spécification des Commits Conventionnels

Une PR doit être faite avec une branche à jour avec la branche develop en rebase (et sans merge) avant demande de fusion, et la fusion doit être demandée dans develop.

Cloner le projet

shell
git clone https://github.com/dnum-mi/vue-dsfr

Installer le projet

Se positionner à la racine du projet, puis lancer la commande

shell
npm install

Si le paquet cypress n'arrive pas à se télécharger lors de la précédente commande, alors il faut télécharger le fichier cypress.zip manuellement sur le site cypress.io, et spécifier le fichier dans la variable CYPRESS_INSTALL_BINARY

shell
CYPRESS_INSTALL_BINARY=/chemin/vers/cypress/cypress.zip npm install

Pré-requis

  • npm : version 10 minimum
  • Node.js : version 20 minimum

Installation des pré-requis (testé sous Ubuntu 22.04)

Suivez la procédure suivante en lançant les commandes détaillées ci-dessous :

  1. Mise à jour des dépôts :
shell
wget -qO- https://deb.nodesource.com/setup_20.x | sudo -E bash -
  1. Installer Node.js :
shell
sudo apt install -y nodejs
  1. (Optionnel) Installer volta (Node Version Manager) :

Avec la commande curl :

shell
curl https://get.volta.sh | bash
  1. Fermer et rouvrir un terminal, ou bien taper la commande suivante dans tous les terminaux déjà ouverts :
shell
source ~/.bashrc
  1. Vérifier la version de Volta installée :
shell
volta --version
  1. La version de node sera utilisée automatiquement

Dans le dossier vue-dsfr, si vous lancer la commande suivante :

shell
node --version

Vous devriez voir 20.x.x

Comment contribuer au projet

À propos des pull-requests

Les commits doivent suivre la spécification des Commits Conventionnels afin que l’outil de release automatique détecte les nouvelles fonctionnalités et les corrections d’anomalies.

Les branches doivent être le plus possible à jour avec la branche develop en rebase (et sans merge) avant demande de fusion, et la fusion doit être demandée dans develop.