Engineering Best Practices

Feb 6, 2013 (Susan, Lorena, Zach, Joe)

Software

• jQuery
• PHP (if database is used)

Database

• MySql

Coding Standards

Please read:

• WordPress Coding Standards
• Python PEP8 coding standards

Decision point: Bootstrap, Zerb, Wordpress (TBD)

In addition

Each file MUST have a header that contains:

• File name
• Author
• Brief description
• A list of functions, each followed by the initial developer

Each Function MUST have a header with:

• Brief description
• Parameters input AND types
• Return variable AND type

Variable Naming Conventions:

• Labels MUST be meaningful
• Any GLOBAL parameters will be in the GLOBAL array (PHP)
• By convention, use underscore_case for PHP (e.g. new_variable, new_function())
• By convention, use camelCase for JavaScript (e.g. newVariable, newFunction())

File Structure

• Version control using Git
• MVC architecture