JavaScript Style Guidelines for OpenStack.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 96195f64a5 OpenDev Migration Patch 1 month ago
doc Change openstack-dev to openstack-discuss 5 months ago
spec Update descriptions of ES6-related options 3 years ago
.editorconfig Initial Commit 3 years ago
.eslintrc Disallow space between a function & opening paren 2 years ago
.eslintrc-es2015 Added config with ES2015-only rules 2 years ago
.gitignore Copy .gitignore from js-generator-openstack template 2 years ago
.gitreview OpenDev Migration Patch 1 month ago
.npmrc Added npm default config. 3 years ago
.zuul.yaml import zuul job settings from project-config 8 months ago
LICENSE Initial Commit 3 years ago
README.md Added config with ES2015-only rules 2 years ago
bindep.txt Fix the gate npm docs failure 2 years ago
es2015.js Added config with ES2015-only rules 2 years ago
index.js Added config with ES2015-only rules 2 years ago
load-config.js Added config with ES2015-only rules 2 years ago
package.json Replace openstack.org git:// URLs with https:// 1 month ago

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.