openstack
/
eslint-config-openstack
Code Issues Proposed changes
JavaScript Style Guidelines for OpenStack.
79 Commits 1 Branch 9 Tags 1.1 MiB
JavaScript 100%
Go to file
Michael Krotscheck c164499480 Added policy for aging patches 
This proposes an 'abandon after one month of inactivity' rule for
extant patches on this project. It is intended to keep the list of
outstanding patches small and manageable.

Change-Id: Ie12eb568b61995ef77570774513806b7da0f964d
 		2016-02-29 10:02:59 -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 policy for aging patches 2016-02-29 10:02:59 -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.

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.