openstack/eslint-config-openstack
Code Issues Proposed changes
JavaScript Style Guidelines for OpenStack.
80 Commits 1 Branch 9 Tags 1.1 MiB
JavaScript 100%
1c762b4923
Go to file
Michael Krotscheck 1c762b4923 Clarified wording in governance 
This patch clarifies the wording on a few governance statements.
First, the intent of the rule approval policy is to encourage more
pairs of eyeballs - thus the wording was changed from +5 to 'five
positive votes'. Secondly - library upgrades should _never_ change
the existing rule set, because they already impose changes due
to bugfixes in the rules themselves.

Change-Id: I4f2765bcd04cb50da94ac121259c0cc8244bda19
2016-03-01 09:42:28 -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
index.js Stop using IIFE for index.js 2015-10-07 10:12:33 -07:00
LICENSE Initial Commit 2015-06-23 18:40:37 -07:00
package.json 1.2.4 2016-02-24 04:42:41 -08:00
README.md Clarified wording in governance 2016-03-01 09:42:28 -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 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.