openstack
/
eslint-config-openstack
Code Issues Proposed changes
JavaScript Style Guidelines for OpenStack.
77 Commits 1 Branch 9 Tags 1.1 MiB
JavaScript 100%
Go to file
Michael Krotscheck ec2fc1be14 Added approval policy for library upgrades 
This patch adds governance policy for eslint library upgrades.
As these upgrades may include rules from upstream, as well as
deprecate old rules, these patches should never enable new rule
sets.

Change-Id: I0cc51033dd547389bc2f01c37bb697d1771dd9cd
 		2016-02-29 10:02:15 -08:00
spec Enable strict 2015-09-22 10:24:59 -07:00
.editorconfig Initial Commit 2015-06-23 18:40:37 -07:00
.eslintrc Merge "Disable no-undefined" 2016-01-29 17:00:17 +00: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
.npmrc Added npm default config. 2015-08-18 14:45:23 -07:00
LICENSE Initial Commit 2015-06-23 18:40:37 -07:00
README.md Added approval policy for library upgrades 2016-02-29 10:02:15 -08:00
index.js Stop using IIFE for index.js 2015-10-07 10:12:33 -07:00
package.json 1.2.4 2016-02-24 04:42:41 -08: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

To add these rules to your project, follow these steps.

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

Approval Policies

If you would like to contribute, please follow OpenStack's contribution guidelines.

Rules only land with consensus

Patches that activate, deactivate, or modify rules, should only be merged if a consensus of reviewers is reached. In this case, consensus means at least five +1 votes, with no -1 votes. Cores may not override and/or ignore -1 votes.

Library upgrades require two cores

Patches that upgrade eslint only require two core approvers to land. These patches should add new upstream rules in a deactivated state, and delete any deprecated rules.