..  _javascript_style_guide:

###############################
Open edX JavaScript Style Guide
###############################

This section describes the requirements and conventions used to contribute
JavaScript programming to the Open edX platform.

.. contents::
 :local:
 :depth: 2

******************
JavaScript Version
******************

The Open edX project utilizes `babel-preset-env`_ to support the latest version of JavaScript.
This automates management of syntax transforms and browser polyfills.

**********
Code Style
**********

In order to standardize and enforce the Open edX project's JavaScript coding style across
multiple codebases, we utilize a shared `ESLint Config`_.

.. Link targets

.. _babel-preset-env: https://babeljs.io/docs/babel-preset-env
.. _ESLint Config: https://github.com/openedx/eslint-config


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
+--------------+-------------------------------+----------------+--------------------------------+
|              |                               |                |                                |
+--------------+-------------------------------+----------------+--------------------------------+