2019-03-14 15:00:34 +01:00
|
|
|
# Styleguide
|
|
|
|
|
|
2019-05-19 11:38:09 +02:00
|
|
|
## Elixir
|
2019-03-14 15:00:34 +01:00
|
|
|
|
|
|
|
|
We format our code with the Elixir Formatter and check for issues with [Credo](https://github.com/rrrene/credo) (a few rules are not blocking).
|
|
|
|
|
|
2019-05-19 11:38:09 +02:00
|
|
|
Please run these two commands before pushing code:
|
2019-03-14 15:00:34 +01:00
|
|
|
* `mix format`
|
|
|
|
|
* `mix credo`
|
|
|
|
|
|
|
|
|
|
These two commands must not return an error code, since they are required to pass inside CI.
|
|
|
|
|
|
2019-05-19 11:38:09 +02:00
|
|
|
## Front-end
|
2019-03-14 15:00:34 +01:00
|
|
|
|
|
|
|
|
We use `tslint` with the `tslint-config-airbnb` preset.
|
2019-04-10 17:30:18 +02:00
|
|
|
Errors should be reported when running in dev mode `yarn run dev` or when building a production bundle `yarn run build`.
|
2019-03-19 11:16:03 +01:00
|
|
|
|
2019-05-19 11:38:09 +02:00
|
|
|
Please run the following command before pushing code `yarn run lint`.
|
2019-03-22 11:04:57 +01:00
|
|
|
|
|
|
|
|
This command must not return an error code, since it's required to pass inside CI.
|
|
|
|
|
|
2019-03-19 11:16:03 +01:00
|
|
|
We also try to follow the [official Vue.js style guide](https://vuejs.org/v2/style-guide/).
|
