summaryrefslogtreecommitdiffstats
path: root/STYLE-GUIDE.md
diff options
context:
space:
mode:
authorChristopher Speller <crspeller@gmail.com>2015-07-28 12:14:40 -0400
committerChristopher Speller <crspeller@gmail.com>2015-07-28 12:14:40 -0400
commitbf5548ad6da9dc4a12ffde56658f7d9a9748cb80 (patch)
tree4d8776b0a3bd4895d2b1721c1dd33578da1fe78a /STYLE-GUIDE.md
parent5a4b736c8a60e3662e2f020af444274a3fb083e8 (diff)
downloadchat-bf5548ad6da9dc4a12ffde56658f7d9a9748cb80.tar.gz
chat-bf5548ad6da9dc4a12ffde56658f7d9a9748cb80.tar.bz2
chat-bf5548ad6da9dc4a12ffde56658f7d9a9748cb80.zip
Minor tweaks to style guide
Diffstat (limited to 'STYLE-GUIDE.md')
-rw-r--r--STYLE-GUIDE.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
index 345fe6cdc..a370e7d74 100644
--- a/STYLE-GUIDE.md
+++ b/STYLE-GUIDE.md
@@ -2,7 +2,7 @@
1. [GO](#go)
2. [Javascript](#javascript)
-3. [React/JSX](#jsx)
+3. [React-JSX](#react-jsx)
## Go
@@ -122,7 +122,11 @@ function wrongGetStr(stuff) {
}
```
-## React/JSX
+## React-JSX
+
+Part of the buld process is running ESLint. ESLint is the final athority on all style issues. PRs will not be accepted unless there are no errors or warnings running ESLint. The ESLint configuration file can be found in: [web/react/.eslintrc](https://github.com/mattermost/platform/blob/master/web/react/.eslintrc.json)
+
+Instructions on how to use ESLint with your favourite editor can be found here: [http://eslint.org/docs/user-guide/integrations](http://eslint.org/docs/user-guide/integrations)
This is an abriged version of the [Airbnb React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react#airbnb-reactjsx-style-guide). Anything that is unclear here follow that guide. If there is a conflict, follow what is said below.