# TQ.Components ## Table des Matières 1. [Introduction](#introduction) 2. [Guide de démarrage rapide](#guide-de-démarrage-rapide) 3. [Contribution](#contribution) 4. [Types de release](#types-de-release) 5. [TODO](#todo) 6. [Crédits](#credits) ## Introduction Cette librairie de composants a été développée spécifiquement pour les besoins de Télé-Québec. Elle offre une collection de composants Web réutilisables et stylisés, construits avec des technologies modernes: - [Lit](https://lit.dev/) - Framework pour créer des Web Components - [Shoelace](https://shoelace.style/) - Collection de composants UI construits avec des standards Web ## Guide de démarrage rapide ### Installation 1. Installer les dépendances du projet et configurer Playwright: ```bash pnpm run setup ``` ### Développement 2. Pour créer un nouveau composant: ```bash pnpm run create ``` 3. Lancer le serveur de développement local: ```bash pnpm run dev ``` ## Contribution ### Branches - `next` - Branche principale de développement pour la prochaine itération - `feat/mycomponent` - Nomenclature pour les branches de fonctionnalités ### Processus de développement 1. Créer une branche de feature à partir de `next` 2. Développer la fonctionnalité 3. Soumettre une pull request vers `next` 4. Les tests automatisés seront exécutés via le pipeline TESTS-TQ.Components ### Processus de release 1. Exécuter le pipeline CI-TQ.Components et sélectionner le type de release 2. Exécuter le pipeline CD-TQ.Components pour déployer ## Types de release - `patch` (0.0.X) - Corrections de bugs et changements rétrocompatibles - `minor` (0.X.0) - Nouvelles fonctionnalités avec possibles changements mineurs non-rétrocompatibles - `major` (X.0.0) - Changements majeurs avec rupture de compatibilité ## TODO - [ ] Implémenter un changelog automatisé ## Crédits Construit avec: - [Lit](https://lit.dev/) - Framework Web Components - [Shoelace](https://shoelace.style/) - Bibliothèque de composants UI