Engineering Standards

Intro

A list of engineering standards we follow.

File overview

Written in layers:

1. index.js is the entry point
2. server.js starts and stops the server
3. router.js handlers all the routing functions and calls the files from the next layer
4. All the helper functions we have been using to power the app.

Feature Submission

• Make sure to have 100% code coverage. We don't want any uncovered cases due to the nature of the project (databases)
• Only merge when you have 2 or more approvals from admins
• Pick features from the project board. They are ranked by priority.

Work flow

• Make sure you tag your issue in your commit that. The example below references issue #15, a logging feature
  • git commit -m 'updates #15: Adds testing to logging module'
  • git commit -m 'closes #15: fixes test cases from code review'