Coding Style

[EternalDeiwos]

As discussed in various hangouts, issues and PRs (anvilresearch/jwa#8 for example): we have a particular style of coding. This issue is for formally establishing, discussing and querying these coding guidelines with the intention of it being published alongside, or within our CONTRIBUTOR.md document.

[christiansmith]

I propose we add a checklist to this issue for things to discuss, agree upon, and document.

• package structure
• comments
• whitespace
• naming conventions
• classes, inheritance, mixins, and modules
• functions and methods
• use of functional style vs object orientation
• variable and constant declarations
• destructuring assignment
• promise chaining
• dependency injection (constructor)
• testing
  • test descriptions and organization
  • data driven testing
  • assertion style
  • mocks and spies
  • http mocking

What other code style and patterns would we want to discuss and document?