openstack
/
eslint-config-openstack
Code Issues Proposed changes
JavaScript Style Guidelines for OpenStack.
138 Commits 1 Branch 9 Tags 1.1 MiB
JavaScript 100%
Go to file
Ghanshyam Mann a0bea8814f migrate to Xena testing runtime 
As per Xena cycle testing runtime [1] and community goal [2]
we need to migrate upstream CI/CD to Ubuntu Focal(20.04)
and Node.js 14.

Depends-On: https://review.opendev.org/c/openstack/openstack-zuul-jobs/+/789481
Story: #2007865
Task: #40212

[1] https://governance.openstack.org/tc/reference/runtimes/xena.html
[2] https://governance.openstack.org/tc/goals/selected/victoria/migrate-ci-cd-jobs-to-ubuntu-focal.html

Change-Id: I7cfdfb11869ac90244561d34d1f4fdf26a5e8ad0
 		2021-05-04 06:37:38 +00:00
doc Fix building of the pdf documentation 2021-03-30 18:20:27 +02: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 Disallow space between a function & opening paren 2016-10-27 13:44:24 +00:00
.eslintrc-es2015 Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
.gitignore Copy .gitignore from js-generator-openstack template 2016-11-02 13:30:33 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:00 +00:00
.npmrc Added npm default config. 2015-08-18 14:45:23 -07:00
.zuul.yaml migrate to Xena testing runtime 2021-05-04 06:37:38 +00:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2020-04-23 03:31:09 +00:00
LICENSE Initial Commit 2015-06-23 18:40:37 -07:00
README.rst Fix building of the pdf documentation 2021-03-30 18:20:27 +02:00
bindep.txt Fix building of the pdf documentation 2021-03-30 18:20:27 +02: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
load-config.js Added config with ES2015-only rules 2016-07-29 12:04:22 +03:00
package.json Fix building of the pdf documentation 2021-03-30 18:20:27 +02:00
tox.ini Fix building of the pdf documentation 2021-03-30 18:20:27 +02:00

README.rst

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.