mirror of
https://github.com/betagouv/mon-entreprise
synced 2025-02-09 00:35:00 +00:00
046076f32d
Et éviter de créer de la confusion si une prochaine commande compile devait venir pour la compilation des règles publicodes
156 lines
6.5 KiB
Markdown
156 lines
6.5 KiB
Markdown
# Comment contribuer ?
|
||
|
||
Merci de prendre le temps de contribuer ! 🎉
|
||
|
||
Voici quelques informations pour démarrer :
|
||
|
||
## 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/mon-entreprise/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/mon-entreprise/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 :
|
||
|
||
- [TypeScript](https://www.typescriptlang.org) pour ajouter un système de typage à notre code JavaScript. Le typage n'est pas utilisé partout et il n'est pas obligatoire de le prendre en compte pour contribuer.
|
||
- [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
|
||
- [Ramda](https://ramdajs.com) comme libraire d'utilitaires pour manipuler les listes/objects/etc (c'est une alternative à lodash ou underscore)
|
||
- [Mocha](https://mochajs.org), [Jest](https://jestjs.io) et [Cypress](https://www.cypress.io) pour les l'execution des tests. Plus d'informations dans la section consacrée aux tests.
|
||
|
||
### 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/mon-entreprise.git && cd mon-entreprise
|
||
|
||
# Install the Javascript dependencies through Yarn
|
||
yarn install
|
||
|
||
# Watch changes in publicodes and run the server for mon-entreprise
|
||
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 :
|
||
|
||
https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
|
||
|
||
- 🎨 `:art:` when working on the app's visual style
|
||
- 🐎 `:racehorse:` when improving performance
|
||
- 📝 `:memo:` when writing docs
|
||
- 🐛 `:bug:` when fixing a bug
|
||
- 🔥 `:fire:` when removing code or files
|
||
- 💚 `:green_heart:` when fixing the CI build
|
||
- ✅ `:white_check_mark:` when adding tests
|
||
- ⬆️ `:arrow_up:` when upgrading dependencies
|
||
- :sparkles: `:sparkles:` when formatting, renaming, reorganizing files
|
||
|
||
Et ceux spécifiques au projet :
|
||
|
||
- :gear: `:gear:` pour une contribution au moteur qui traite les YAML
|
||
- :hammer: `:hammer:` pour une contribution à la base de règles
|
||
- :calendar: `:calendar:` pour un changement de règle du à une évolution temporelle (en attendant mieux)
|
||
- :chart_with_upwards_trend: `:chart_with_upwards_trend:` pour une amélioration du tracking
|
||
- :alien: `:alien:` pour ajouter des traductions
|
||
- :wheelchair: `:wheelchair:` pour corriger les problèmes liés à l'accessibilité
|
||
- :fountain_pen: `:fountain_pen:` pour séparer les commits liés à la modification du contenu
|
||
|
||
### Tests
|
||
|
||
Pour executer les tests unitaires :
|
||
|
||
```sh
|
||
$ yarn run test-common
|
||
```
|
||
|
||
Pour le snapshot testing :
|
||
|
||
```sh
|
||
$ yarn run test-regressions
|
||
```
|
||
|
||
Si vous souhaitez mettre à jour les snapshots vous pouvez utiliser le paramètre `--updateSnapshot`, son raccourci `-u`, ou encore le [mode interactif](https://jestjs.io/docs/en/snapshot-testing#interactive-snapshot-mode).
|
||
|
||
Enfin pour les tests d'intégration :
|
||
|
||
```sh
|
||
$ yarn run cypress run
|
||
```
|
||
|
||
### Traduction 👽
|
||
|
||
Le site est disponible en français, et en anglais sur https://mycompanyinfrance.com
|
||
|
||
Les traductions se trouvent dans le répertoire `source/locales`.
|
||
|
||
La librairie utilisée pour la traduction de l'UI est
|
||
[react-i18next](https://react.i18next.com/).
|
||
|
||
Lorsque l'on introduit une nouvelle chaîne de caractère dans l'UI il faut
|
||
systématiquement penser à gérer sa traduction, via un composant `<Trans>`, ou
|
||
via la fonction `t`
|
||
|
||
Le circle-ci fait une analyse statique du code pour repérer les chaînes non
|
||
traduites, dans le moteur et l'UI :
|
||
|
||
```sh
|
||
$ yarn run i18n:rules:check
|
||
$ yarn run i18n:ui:check
|
||
```
|
||
|
||
Pour traduire automatiquement les chaînes manquantes via l'api Deepl :
|
||
|
||
```sh
|
||
$ yarn run i18n:rules:translate
|
||
$ yarn run i18n:ui:translate
|
||
```
|
||
|
||
N'oubliez pas de vérifier sur le diff que rien n'est choquant.
|
||
|
||
### CI/CD
|
||
|
||
- [CircleCI](https://circleci.com/) s'occupe de faire tourner les builds et
|
||
tests.
|
||
- [Netlify](https://www.netlify.com/), s'occupe de l’hébergement du site sur Internet
|
||
sur internet avec gestion des DNS.
|
||
|
||
### Analyse des bundles
|
||
|
||
La commande `yarn run build:analyse-bundle` gènere une visualisation interactive du
|
||
contenu packagé, cf.
|
||
[webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)
|
||
|
||
## Documentation
|
||
|
||
### Publicodes
|
||
|
||
Un tutoriel sur publicode est disponible sur https://publi.codes.
|
||
|
||
Un wiki contenant des informations intéressantes sur publicode et le
|
||
raisonnement ayant abouti à ce langage sont dispos sur le repository
|
||
[betagouv/publicodes](https://github.com/betagouv/publicodes/wiki), qui est par
|
||
ailleurs inutilisé.
|
||
|
||
Pour se familiariser avec les règles, vous pouvez jeter un œil aux fichiers
|
||
contenant les règles elles-mêmes (dans le dossier `rules`) mais cela peut
|
||
s'avérer assez abrupt.
|
||
|
||
Essayez plutôt de jeter un oeil [aux tests](./test/mécanismes/expressions.yaml)
|
||
dans un premier temps, puis au [mécanismes en
|
||
place](./source/engine/mecanisms.yaml).
|