Commit 2fc91033 authored by Joseph Weston's avatar Joseph Weston

Add instructions on frontend codestyle to README

parent dd2a7942
......@@ -49,7 +49,7 @@ You can run the tests by running
### Code style
#### Python
Adhere to PEP8, but use a column width of 120 characters (instead of 79).
Adhere to [PEP8](https://www.python.org/dev/peps/pep-0008/), but use a column width of 120 characters (instead of 79).
If you followed the instructions above, the linter `flake8` is installed in your virtual environment. If you use Visual Studio Code, install the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) extension and add the following lines to your workspace settings:
......@@ -65,6 +65,13 @@ If you use Atom, install the [linter-flake8](https://atom.io/packages/linter-fla
"editor":
"preferredLineLength": 120
#### Javascript
Adhere to [StandardJS](https://standardjs.com/).
If you use Visual Studio Code, install the [vscode-standardjs](https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs) plugin.
If you use Atom, install the [linter-js-standard-engine](https://atom.io/packages/linter-js-standard-engine) plugin.
### Adding dependencies
#### Server-side
......@@ -80,4 +87,4 @@ Yarn keeps track of all the client-side dependancies in `package.json` when you
yarn install
## License
Zesje is licensed under AGPLv3, which can be found in `LICENSE`. An summary of this license with it's permissions, conditions and limitations can be found [here](https://choosealicense.com/licenses/agpl-3.0/).
\ No newline at end of file
Zesje is licensed under AGPLv3, which can be found in `LICENSE`. An summary of this license with it's permissions, conditions and limitations can be found [here](https://choosealicense.com/licenses/agpl-3.0/).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment