Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

19 lines (17 loc) · 1.29 KB

How to contribute

First of all - thank you for interest in contributing to the development of midio! If you are wondering how to best contribute, you are in the right place.

Submitting changes

An ideal workflow for improving midio is as follows:

  1. Create or find an issue
  2. Create a Pull Request
  3. Fill out the Pull Request template
  4. Discuss your changes on the Pull Request
  5. Code review
  6. Merge the change to master

Coding conventions

  • We indent using 4 spaces
  • We put spaces after any list or function parameters ([1, 2, 3], not [1,2,3]), and around operators (x += 1, not x+=1)
  • We use camelCase for functions, variables, and just about everything else except UPPERCASE for global variables
  • We use Visual Studio Code, as mentioned in the README
  • We use Visual Studio Code JSDoc commenting style on anything more complex than a variable