From a0c0a4ae4fcee3c7e12e1ffdee95e670aa82e60a Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Sun, 18 Sep 2016 16:25:16 +1200 Subject: [PATCH] Updated docs with sass-lint references --- docs/en/05_Contributing/02_Build_Tooling.md | 4 +++- docs/en/05_Contributing/13_CSS_Coding_Conventions.md | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/en/05_Contributing/02_Build_Tooling.md b/docs/en/05_Contributing/02_Build_Tooling.md index b5e985bc2..cf23b7055 100644 --- a/docs/en/05_Contributing/02_Build_Tooling.md +++ b/docs/en/05_Contributing/02_Build_Tooling.md @@ -99,7 +99,9 @@ $ npm run css -- --watch $ npm run lint ``` -Run `eslint` over JavaScript files reports errors. +Run linters (`eslint` and `sass-lint`) linters to enforce +our [JavaScript](/contributing/javascript_coding_conventions) and +[CSS](/contributing/css_coding_conventions) coding conventions. ### test diff --git a/docs/en/05_Contributing/13_CSS_Coding_Conventions.md b/docs/en/05_Contributing/13_CSS_Coding_Conventions.md index f397ad74b..5adfe6af8 100644 --- a/docs/en/05_Contributing/13_CSS_Coding_Conventions.md +++ b/docs/en/05_Contributing/13_CSS_Coding_Conventions.md @@ -29,9 +29,12 @@ File naming and style include ordering is inspired by We use [sass-lint](hhttps://github.com/sasstools/sass-lint) to ensure all new SCSS written complies with the rules below. It will be provided as an npm dev dependency. -Ther eare also quite a few [sass-lint IDE integrations]https://github.com/sasstools/sass-lint#ide-integration) which highlight any linting errors right in your code. +Ther eare also quite a few [sass-lint IDE integrations]https://github.com/sasstools/sass-lint#ide-integration) +which highlight any linting errors right in your code. + We strongly recommend installing one of these into the editor of your choice, to -avoid the frustration of failed pull requests. +avoid the frustration of failed pull requests. You can run the checks on console +via `npm run lint`. ## File and Folder Naming