From 215c9a5a99f60ae6d4ce7c711e9914bcc8a6859e Mon Sep 17 00:00:00 2001
From: Maxime Quandalle <maxime@quandalle.com>
Date: Tue, 9 Jul 2019 14:17:09 +0200
Subject: [PATCH] Prose dans CONTRIBUTION.md

---
 CONTRIBUTION.md | 48 ++++++++++++++++++++++++++++++++++++++++++++----
 README.md       | 17 +++--------------
 2 files changed, 47 insertions(+), 18 deletions(-)

diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
index 623d3e753..6d41a47d1 100644
--- a/CONTRIBUTION.md
+++ b/CONTRIBUTION.md
@@ -1,10 +1,50 @@
-## Style du code
+# Comment contribuer ?
 
-Nous utilisons [Prettier](https://prettier.io/). L'idéal est que chaque contributeur l'installe dans son éditeur de texte avec un formattage automatique à chaque CTRL-S.
+Merci de prendre le temps de contribuer ! 🎉
 
-De même, nous avons une configuration [eslint](http://eslint.org/), qui permet par exemple d'éviter de garder des variables inutilisées.
+Voici quelques informations pour démarrer :
 
-## Messages de commit
+## Rapport de bug, nouvelles fonctionnalités
+
+Nous utilisons GitHub pour suivre tous les bugs et discussions sur les nouvelles fonctionnalités. Pour rapporter un bug ou proposer une évolution vous pouvez [ouvrir une nouvelle discussion](https://github.com/betagouv/syso/issues/new). N'hésitez pas à utiliser la recherche pour vérifier si le sujet n'est pas déjà traité dans une discussion ouverte.
+
+## Développement
+
+Si vous voulez participer au développement de nouvelles fonctionnalités, vous pouvez consulter la liste des «[good first issue](https://github.com/betagouv/syso/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Anew%3A+good+first+issue%22) ». Ce sont des fonctionnalités intéressantes qui ne sont normalement pas trop complexe à implémenter. N'hésitez pas à poser toutes vos questions sur ces issues !
+
+### Technologies
+
+L'application est écrite en JavaScript, elle est exécuté uniquement côté client — il n'y a pas de serveur applicatif, nous générons des fichiers `.html` statiques
+
+Nous utilisons :
+
+- [Yarn](https://yarnpkg.com/fr) pour la gestion des dépendances (à la place de NPM qui est souvent utilisé dans les applications JavaScript)
+- [React](https://reactjs.org) pour la gestion de l'interface utilisateur
+- [Redux](https://redux.js.org) pour gérer le “state” de l'application côté client
+- [Prettier](https://prettier.io/) pour formater le code source, l'idéal est de configurer votre éditeur de texte pour que les fichiers soit formatés automatiquement quand vous sauvegardez un fichier. Si vous utilisez [VS Code](https://code.visualstudio.com/) cette configuration est automatique.
+- [Webpack](https://webpack.js.org) pour le “bundling”
+- [Eslint](http://eslint.org) qui permet par exemple d'éviter de garder des variables inutilisées
+- [Flow](https://flow.org/) pour ajouter un système de typage à notre code JavaScript. Le typage Flow n'est pas utilisé partout et il n'est pas obligatoire de le prendre en compte pour contribuer.
+- [Ramda](https://ramdajs.com) comme libraire d'utilitaires pour manipuler les listes/objects/etc (c'est une alternative à lodash ou underscore)
+
+### Démarrage
+
+Si l'historique des commits est trop volumineux, vous pouvez utiliser le paramètre `depth` de git pour ne télécharger que les derniers commits.
+
+```
+# Clone this repo on your computer
+git clone --depth 100 git@github.com:betagouv/syso.git && cd syso
+
+# Install the Javascript dependencies through Yarn
+yarn install
+
+# Run the server
+yarn start
+```
+
+L'application est exécuté sur https://localhost:8080/mon-entreprise pour la version française et http://localhost:8080/infrance pour la version anglaise.
+
+### Messages de commit
 
 A mettre sans retenue dans les messages de commit :
 
diff --git a/README.md b/README.md
index c0f16e8d7..0b861d6e1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 ![La loi papier sur la page de droite du dessin de l'énorme livre de droit, sera (page de droite) augmentée par du code interprétable](https://raw.githubusercontent.com/betagouv/syso/master/source/sites/embauche.gouv.fr/images/logo.png)
 
-This repository powers [mycompanyinfrance.fr](https://mycompanyinfrance.fr) and [embauche.beta.gouv.fr](https://embauche.beta.gouv.fr).
+This repository powers [mycompanyinfrance.fr](https://mycompanyinfrance.fr) and [mon-entreprise.fr](https://mon-entreprise.fr).
 
 It's a React, Redux, Webpack website hosted on Netlify with no backend.
 
@@ -12,20 +12,9 @@ Developed by the french public startup incubator, [beta.gouv.fr](https://beta.go
 
 Most of the documentation (including issues and the wiki) is written in french, please raise an [issue](https://github.com/betagouv/syso/issues/new) if you are interested and do not speak French.
 
-## Run it
+## Contribute
 
-```
-# Clone this repo on your computer
-git clone --depth 100 git@github.com:betagouv/syso.git && cd syso
-
-# Install the Javscript dependencies through Yarn
-yarn install
-
-# Run the server
-yarn start
-```
-
-The app runs on https://localhost:8080/mon-entreprise. The english version deployed on mycompanyinfrance.fr is at http://localhost:8080/infrance.
+If you want to contribute to this application, please check out [CONTRIBUTION.md](./CONTRIBUTION.md).
 
 ## Supported browsers