CyberScout Development Standards and Coding Conventions

The purpose of this repository is to document CyberScout's development standards and coding conventions. The standards outlined here should be adhered to whenever possible. Any deviance should be justified and documented.

Code tells a story, and the story is easier to understand when the readers can expend their effort on following the narrative, rather than wading through the "noise" of the syntax. For this reason, every effort should be made to adhere to these standards. They will also be enforced through code reviews, and possibly even with tooling (formatters, linters, etc.).

Table of Contents

Development Standards and Guidelines

• General
• Version Control
• Comments
• Logging
• Testing
• Databases

Coding Conventions

• All languages — Read this first. All language-specific documents build on this one.
• Java
  • Frameworks and Libraries
• Groovy
• PHP
  • Frameworks and Libraries
• JavaScript
• HTML
• CSS

Checklists

The following checklists should be followed when performing any of the associated actions:

• Code Release