From b6fc0e931de3d6328d6fd222b51c63d907c8c963 Mon Sep 17 00:00:00 2001 From: vrde Date: Mon, 31 Aug 2015 19:13:09 +0200 Subject: [PATCH] Update readme with doc on how to install the linter --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 270c4a5f..a3258576 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ Additionally, to work on the white labeling functionality, you need to edit your ``` -Code Conventions -================ +JavaScript Code Conventions +=========================== For this project, we're using: * 4 Spaces @@ -42,6 +42,15 @@ For this project, we're using: * We don't use camel case for file naming but in everything Javascript related * We use `let` instead of `var`: [SA Post](http://stackoverflow.com/questions/762011/javascript-let-keyword-vs-var-keyword) + +SCSS Code Conventions +===================== +Install [lint-scss](https://github.com/brigade/scss-lint), check the [editor integration docs](https://github.com/brigade/scss-lint#editor-integration) to integrate the lint in your editor. + +Some interesting links: +* [Improving Sass code quality on theguardian.com](https://www.theguardian.com/info/developer-blog/2014/may/13/improving-sass-code-quality-on-theguardiancom) + + Testing =============== We're using Facebook's jest to do testing as it integrates nicely with react.js as well. @@ -127,4 +136,4 @@ Moar stuff - [24ways.org: JavaScript Modules the ES6 Way](http://24ways.org/2014/javascript-modules-the-es6-way/) - [Babel: Learn ES6](https://babeljs.io/docs/learn-es6/) - [egghead's awesome reactjs and flux tutorials](https://egghead.io/) -- [Crockford's genious Javascript: The Good Parts (Tim has a copy)](http://www.amazon.de/JavaScript-Parts-Working-Shallow-Grain/dp/0596517742) \ No newline at end of file +- [Crockford's genious Javascript: The Good Parts (Tim has a copy)](http://www.amazon.de/JavaScript-Parts-Working-Shallow-Grain/dp/0596517742)