Documentation proofing

This commit is contained in:
Armando Lüscher
2019-05-19 11:38:09 +02:00
committed by Thomas Citharel
parent f3ff8c5b1e
commit 2821e5f12a
10 changed files with 92 additions and 91 deletions

View File

@@ -1,21 +1,21 @@
# Styleguide
# Elixir
## Elixir
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).
Please run those two commands before pushing code:
Please run these two commands before pushing code:
* `mix format`
* `mix credo`
These two commands must not return an error code, since they are required to pass inside CI.
# Front
## 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`.
Please run the following command before pushing code `yanr run lint`.
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.