CONTRIBUTING.md

Je veux les instructions en français

Contributing Guide

Before submitting your contribution, please read the following guidelines.

• English instructions coming soon.

Instructions à suivre pour les contributeurs

Avant de soumettre votre contribution, veuillez prendre note de ces quelques lignes directrices.

• Lire à propos de la structure du monorepo.

• Créer une feature branch à partir de la develop ou master en fonction des changements effectué (voir plus bas). Le nom de votre branche devrait toujours débuter par feature/ ou bugfix/.

• S'assurer que le repository compile correctement (yarn run install).

• S'assurer que les tests s'exécutent avec succès (yarn run test). Si une mise à jour des snapshots est nécessaire (yarn run test:update).

• S'assurer que le code respecte les règles de formattage (yarn run lint).

• Les versions des projets modul suivent la convention du Semantic versioning. Lors de la création de la pull Request (PR), il est important de bien suivre les instructions suivantes:

  • S'il s'agit d'une correction de bogue :

    • Soumettre la PR à partir de la branche ayant comme origine master
    • Ajouter le nom de la composante qui est affectée par le changements au nom de la PR (ex : [m-button] Nom de la PR )
    • Bien remplir tous les sections requise dans la description PR.
    • Ajouter le Label bugfix à la PR.
    • S'assurer que la PR contient les tests unitaires et stories associés.
    • Régler les conflits avec la branche source (s'il y a lieu)

  • S'il s'agit d'une nouvelle fonctionnalité ou d'un changements majeur:

    • Soumettre la PR à partir de la branche ayant comme origine develop
    • Ajouter le nom de la composante qui est affectée par le changements au nom de la PR (ex : [m-button] Nom de la PR )
    • Bien remplir tous les sections requise dans la description PR.
    • Ajouter le label new feature et/ou breaking change à la PR.
    • Mettre a jour la documentation dans le projet modul-website
    • Régler les conflits avec la branche source (s'il y a lieu)

  • S'il s'agit d'un travaux en cours (work in progress):

    • Ajouter le Label work in progress
    • Créer une pull request de type draft
    • Une fois le travail completé, enlevé le label work in progress et convertir la PR comme décrit plus haut.

• Si possible, identifier une ou plusieurs ressources pour procéder à la revue de code. Les codeowner associé(s) seront ajouté automatiquement à la PR et leur approbation est nécessaire avant le merge de la PR.

• Plusieurs commits peuvent être effectués au cours du processus d'approbation d'un PR.

• Un squash merge est effectué lorsque le code est rapporté dans la branche develop ou master.

Structure du monorépo

/packages/modul-[package-name]: Contient les libraries qui composent modul qui sont publiés sur npm

/src/storybook: Environnement de développement storybook pour le projet modul

/src/modul-website: Site de documentation publique du projet modul

/src/meta-generator: Utilitaire permetant la génération de la documentation à partir de code typescript

/conf: Contient les fichiers de configuration (hook, linters, etc.).

/doc: Contient diverse information principalement destinées aux contributeurs internes.