Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 726 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (25 loc) · 726 Bytes

Contributing

  • General
    • No ES6 syntax features or methods, exclusively ES5.
    • Max of five arguments for functions
    • Max depth of four nested blocks
    • 2-spaced soft tabs
  • Naming
    • CamelCase all class names
    • camelBack all variable names
  • Spacing
    • Spaces after all keywords
    • Spaces before all left curly braces
  • Comments
    • Use JSDoc-style comments for methods
    • Single-line comments for ambiguous code
  • Quotes
    • Always use double quotes
    • Only use single quotes when the string contains a double quote
  • Declaration
    • No unused variables
    • No pollution of global variables and prototypes

Testing

$ make test

Linting

$ make lint