Skip to content
This repository has been archived by the owner on Jun 27, 2018. It is now read-only.

Latest commit

 

History

History
27 lines (21 loc) · 978 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 978 Bytes
Raw

Contributing

General

  • snake_case variable/function naming is used.
  • Javascript ES6 is used, so let and const are used instead of var.
  • All API calls are made from the browser via the main.js file. The cors-anywhere proxy makes this possible.

Editor tooling

  • Prettier is used to beautify the .js and .md files.
  • htmlbeautifier, is used to beautify .html files.
  • Editorconfig should be used when submitting any changes.
  • Eslint is used for linting. The projects .eslintrc.json should be detected while you edit.

Git workflow

  1. Fork the repo
  2. Make your changes on a new branch
  3. Keep commits consise with git add -p
  4. Push to your rep, and submit a pull request onto master