From 982858679789132f21f5a0b8bc5f2d23c0c0a3d6 Mon Sep 17 00:00:00 2001 From: Julien Wajsberg Date: Mon, 24 May 2021 22:49:06 +0200 Subject: [PATCH] Ajout d'un fichier CONTRIBUTING.md --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++- 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..36853f0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contribuer à vaccin.click + +Merci de regarder comment contribuer à vaccin.click ! + +Cette extension utilise node pour installer des dépendances utilisées pour le +développement. Ce fichier explique comment les installer et les utiliser. + +## Installation de node + +L'installation de node dépend de votre système. Vous pouvez l'installer +globalement sur votre système avec [les paquets disponibles sur leur +site](https://nodejs.org/fr/), ou bien, si vous voulez une gestion plus fine, +vous pouvez aussi utiliser un script comme [nvm](https://github.com/nvm-sh/nvm#about). + +## Installation des dépendances + +Lorsque `node` est installé, vous pouvez cloner le projet et installer les +dépendances: + +``` +git clone git@github.com:dunglas/vaccin.click.git +cd vaccin.click +npm i +``` + +## Scripts disponibles + +Les scripts suivants sont disponibles: + +- `npm run lint` va lancer prettier localement +- `npm run lint-fix` également, tout en corrigeant les problèmes +- `npm start` lance l'extension dans firefox, et la recharge à chaque + changement. + + On peut utiliser l'option `-f` pour spécifier la version de + Firefox à lancer: `nightly`, `beta`, `firefoxdeveloperedition`, `firefox`, ou + tout simplement un chemin complet: + + `npm start -- -f nightly`\ + `npm start -- -f ~/firefox/firefox` + + La variable d'environnement `$WEB_EXT_FIREFOX` permet de configurer cela de + manière permanente. +- `npm run build` va builder localement l'extension +- `npx web-ext lint` va linter l'extension + +## Trucs et astuces + +(À compléter) diff --git a/README.md b/README.md index da4dcbe..2a03eaf 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ Retrouvez toutes les infos concernant l'extension sur [vaccin.click](https://vac ## Contribuer à l'extension -Voir [le guide publié par Mozilla](https://extensionworkshop.com/documentation/develop/). +Merci ! Tout est décrit dans le fichier `CONTRIBUTING.md`. + +Voir aussi [le guide publié par Mozilla](https://extensionworkshop.com/documentation/develop/). ## Crédits