Coding Standards
Inline with the Engineering Principle We Care About Quality, this folder contains coding standards for the most common languages and frameworks in use at Audacia:
Separate Automated Testing and Secure Coding Standards are also defined.
Language Agnostic Standards
Codebases must be consistent · MUST
Consistency within a codebase is extremely important. Even if the code does not necessarily follow best practices, it may make things worse to introduce inconsistency by only changing a small section of it.
For example, if a codebase currently uses spaces for indentation, don’t start using tabs in some files (and vice-versa).
See Google’s style guide for more information.
Data must not be hard-coded · MUST
Values should be configurable, e.g. read from a configuration file or a database, rather than hard-coding in the application code.
Examples of values to particularly avoid hard-coding are:
- Email addresses to receive error or alert emails
- Something liable to change outside of the control of the application, such as the VAT rate