Files
Ghanshyam Mann 6f6fa9f2f8 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: I6feaa5e6ef9ec56094cbb725a44893aabb83dd24
2020-04-23 03:31:09 +00:00

1.2 KiB

Welcome to eslint-config-openstack developer documentation!

Introduction

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.

For Contributor

If you are a new contributor to eslint-config-openstack please refer: contributor/contributing

contributor/contributing

Administrator's Guide

Introduction to eslint-config-openstack <readme> Installing eslint-config-openstack in your project <installation> Contributing to eslint-config-openstack <contributing> Releasing a version of eslint-config-openstack <releasing>