JavaScript Style Guidelines for OpenStack.
Go to file
Michael Krotscheck 499208e3a8 Moved js-yaml to dependencies.
The index.js script which imports our eslint configuration requires
that js-yaml be accessible, however it was not included in the
project's dependencies. This moves it from devDependencies (installed
during packaging) to dependencies (installed always).

Change-Id: I7f7b0967b86f5312f5801fb4dbfbe72a453583aa
2015-07-14 08:59:20 -07:00
spec Initial Commit 2015-06-23 18:40:37 -07:00
.editorconfig Initial Commit 2015-06-23 18:40:37 -07:00
.eslintrc Initial Commit 2015-06-23 18:40:37 -07:00
.gitignore Initial Commit 2015-06-23 18:40:37 -07:00
.gitreview Added gitreview file to project. 2015-07-09 11:05:51 -07:00
LICENSE Initial Commit 2015-06-23 18:40:37 -07:00
README.md Initial Commit 2015-06-23 18:40:37 -07:00
index.js Initial Commit 2015-06-23 18:40:37 -07:00
package.json Moved js-yaml to dependencies. 2015-07-14 08:59:20 -07:00

README.md

eslint-config-openstack

OpenStack has a set of style guidelines for clarity. OpenStack is a very large code base, spanning dozens of git trees, with over a thousand developers contributing every 6 months. As such, common style helps developers understand code in reviews, move between projects smoothly, and overall make the code more maintainable.

Even though eslint permits overriding rules on a per-project basis, it should be the goal of every project to stay as close to the common guidelines as possible.

Installation

  1. npm install --save-dev eslint eslint-config-openstack
  2. Add extends: "openstack" to your .eslintrc