Style Guide

Languages that we use:

in order from most to least used Python, JavaScript, C++, C, SQL, matlab(yuck).

All credits to https://google.github.io/styleguide/ for 90% of our guidelines

Python

Variable naming

• snake case: a_variable
• Be descriptive with your variable names, always write the full name no aberrations
• ex: ign_s_btn -> ignitor_start_button

Classes

Commenting Generally your variable names should be named verbosely enough and your logic should be easy enough to follow that you should never have to a comment.

However comments in the class definition are very useful.

JavaScript

Always use ES6 standards.

https://google.github.io/styleguide/jsguide.html -> TODO: look at best practices and choose

C++

C

KiCAD