openstack/eslint-config-openstack
Code Issues Proposed changes
JavaScript Style Guidelines for OpenStack.
120 Commits 1 Branch 9 Tags 1.1 MiB
JavaScript 100%
ec845e5e7f
Go to file
Vitaly Kramskikh ec845e5e7f Added config with ES2015-only rules 
This commit adds an additional config, which should be used in
ES2015-based projects. It's available by adding
`extends: openstack/es2015` to project's .eslintrc file.

Change-Id: I5d54cdceb206db7a52ee396eafc513b290e38f86
2016-07-29 12:04:22 +03:00
spec Update descriptions of ES6-related options 2016-05-12 16:01:19 +00:00
.editorconfig Initial Commit 2015-06-23 18:40:37 -07:00
.eslintrc Merge "Enable no-unmodified-loop-condition" 2016-07-21 16:21:30 +00:00
.eslintrc-es2015 Added config with ES2015-only rules 2016-07-29 12:04:22 +03: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
es2015.js Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
index.js Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
LICENSE Initial Commit 2015-06-23 18:40:37 -07:00
load-config.js Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
package.json Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
README.md Added config with ES2015-only rules 2016-07-29 12:04:22 +03: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. If your project is using ES2015, add extends: "openstack/es2015" instead.

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 positive votes (+1 or +2), 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 must add new upstream rules in a deactivated state, and delete any deprecated rules.

Policy upgrades require all cores

Updates to policies and governance on this project require +2 votes from all direct cores on the project. Core votes from the parent OpenStack QA project are optional.

Patches should be abandoned after a month of inactivity

Cores should attempt to keep the list of extant patches small and managable. As such, they should talk to any author whose patch has failed to garner the necessary support, and has experienced one month of inactivity. Reasonable notice should be given to the author before a patch is abandoned.