Skip to content

Guide de Contribution ​

Concept ​

Ce guide fournit une vue d'ensemble du processus de contribution au projet SK_CAPACITOR_DISPLAY, une application SvelteKit/Capacitor pour TVs multi-plateforme. Il couvre les étapes de setup, les règles de développement, et les workflows CI/CD pour assurer une collaboration efficace et une qualité de code élevée.

Prérequis ​

  • Node.js >= 20.9.0
  • npm ou yarn
  • Connaissance de SvelteKit, TypeScript, et Capacitor

Setup Local ​

bash
git clone <repo-url>
cd SK_CAPACITOR_DISPLAY
npm install
npm run dev

Règles de Développement ​

Commits ​

  • Format : type(scope): description
  • Types : feat, fix, refactor, docs, test, chore
  • Exemples :
    • feat(dashboard): add lazy loading for platform functions
    • fix(app-launcher): handle null deviceTypology

Code Style ​

  • TypeScript strict
  • ESLint + Prettier
  • Pas de any implicite
  • JSDoc pour les fonctions publiques

Tests ​

  • Tests unitaires pour toute nouvelle logique
  • Couverture > 80%
  • npm run test avant commit

Ajouter une Nouvelle Plateforme ​

  1. Étendre DeviceTypology dans src/lib/utils/deviceTypology.spec.ts
  2. Ajouter la logique de fallback dans appLauncherDependencies.ts
  3. Créer le module dans src/lib/<platform>/
  4. Mettre Ă  jour features/platform-fallback-spec.md
  5. Ajouter des tests

Workflows CI/CD ​

  • Quality : Lint, typecheck, tests sur push/PR
  • Release : Build automatique sur tag

Support ​

  • Issues GitHub pour bugs/features
  • PRs bien documentĂ©es
  • Revue de code obligatoire

e-novatis
Date de dernière mise à jour : date inconnue