From 86056fe7475a26c1d517400d09c594673a6a0869 Mon Sep 17 00:00:00 2001 From: Joel Glovier Date: Tue, 29 Mar 2016 09:54:22 -0400 Subject: [PATCH] add section about scss linter --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 7954981c24..9a79b3ac2c 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,12 @@ test('visiting /patients', function(assert) { }); ``` +### The SCSS linter + +To keep our styling scalable and consistent, we are using an [scss linter](https://www.npmjs.com/package/ember-cli-scss-lint) that will throw an error in the build if you do not conform to it's syntax rules. The syntax rules are defined in the [`.scss-lint.yml`](https://github.com/HospitalRun/hospitalrun-frontend/blob/master/.scss-lint.yml) file, and documentation for each linter is [available here](https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/linter/README.md). + +The easiest way to work with styles in the project and abide by our linting rules is to install the [linter-scss-lint](https://atom.io/packages/linter-scss-lint) package for Atom. The package will then show you in real time where your styles are breaking the linter and how to correct them. + ## Contributing Contributions are welcome via pull requests and issues. Please see our [contributing guide](https://github.com/hospitalrun/hospitalrun-frontend/blob/master/.github/CONTRIBUTING.md) for more details.