Skip to content
This repository has been archived by the owner on Dec 26, 2022. It is now read-only.

Commit

Permalink
Ajout d'un fichier CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julienw committed May 26, 2021
1 parent 5c40021 commit 9828586
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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)
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 9828586

Please sign in to comment.