Update docs and support

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel
2019-10-11 17:03:18 +02:00
parent fdd3720639
commit fa03c48db3
5 changed files with 74 additions and 38 deletions

View File

@@ -12,11 +12,17 @@ These two commands must not return an error code, since they are required to pas
## Front-end
We use `tslint` with the `tslint-config-airbnb` preset.
Errors should be reported when running in dev mode `yarn run dev` or when building a production bundle `yarn run build`.
### Linting
We use `tslint` and `eslint` with the `airbnb` preset.
Errors should be reported when the development server is running or when building a production bundle `yarn run build`.
Please run the following command before pushing code `yarn run lint`.
This command must not return an error code, since it's required to pass inside CI.
We also try to follow the [official Vue.js style guide](https://vuejs.org/v2/style-guide/).
### Styleguide
We present the components used on Mobilizon's front-end here: https://framasoft.frama.io/mobilizon/frontend/. The documentation is builded through [Vue Styleguidist](https://vue-styleguidist.github.io/)