Powered by

# Contribuer à ce projet

Ils restent encore beaucoup de choses à faire pour améliorer ce projet. Vous pouvez nous aider en contribuant à ce projet.

# Comment contribuer ?

Vous pouvez contribuer de différentes manières :

# Comment installer le projet en local ?

Un devcontainers à été mis en place pour faciliter le développement. Il suffit d'installer Docker et Visual Studio Code et de suivre les étapes suivantes :

  • Cloner le projet
  • Ouvrir le projet dans Visual Studio Code
  • Il va détecter la présence du dossier .devcontainer et cliquer sur le bouton Reopen in Container attendez le chargement...
  • Ouvrir un terminal et lancer la commande npm install
  • Consulter les sous-dossiers de examples-developpement-test pour voir les exemples d'utilisation et suivre les README.md pour les lancer.

Ce devcontainer contient notamment un serveur Lighthouse pour tester le plugin en mode Lighthouse CI

# Lighthouse server

  • En mode devcontainer connectez-vous au container Docker via sa ligne de commande et faites lhci wizard pour configurer le serveur Lighthouse. Reportez cette configuration dans le fichier .lighthouserc.js à la racine du projet.
  • Sans devcontainer vous pouvez installer le serveur Lighthouse en suivant la documentation officielle

# Liste des tâches

  • Plugin ;
  • npx-example ;
  • test lighthouse-ci ;
  • test lightouse CLI ;
  • test (local) ;
  • Continuer à documenter le projet ;
  • Valider les Good and Poor thresholds voir [lighthouse-plugin-ecoindex/utils/index.js#getMetricRange()] ;
  • Ajouter des bonnes pratiques, avec des audits ;
  • Localiser le plugin i18n ;
  • Ajouter des tests unitaires ;
  • ...

# Sources d'aides et d'inspirations

# Contributeurs