Skip to content

Latest commit

History

History
39 lines (29 loc) 路 1.34 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) 路 1.34 KB

Prerequisites

You need to have the latest versions of Node.js and Git installed before you do anything given below.

Coding guidelines

You should ensure that your code meets the coding guidelines listed below

  • Spacing:
    Use two spaces for indentation. No tabs.
  • Quotes:
    Single-quoted strings are preferred to double-quoted strings; however, please use a double-quoted string if the value contains a single-quote character to avoid unnecessary escaping.
  • Variable declaration:
    Don't use var, use let and const to declare your variables.

Guidelines are enforced using ESLint:

$ npm run lint

Submitting code

Any code change should be submitted as a pull request, based on dev branch. The description should explain what the code does.

To contribute to this project

  • First fork this repo on GitHub
  • After that, clone the repo on your local machine
  • Change your current directory to your cloned repo
  • Install the necessary npm dependencies by running npm install
  • Start the local dev server by running npm start
  • Create a new branch from the dev branch that matches the change that you are doing
  • Make your changes
  • Test and lint your changes
  • Commit your changes
  • Create a pull request