-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the place that describes our coding standard in detail, with the intent of highlighting all macroscopic and microscopic components to arrangement and placement of code and text. This coding standard is intended to exclusively speak to layout, formatting, naming, and code hygiene.
To reduce cognitive overhead when working across multiple languages, this coding standard emphasises consistency across boundaries - a unified style keeps the focus on the code rather than on switching between differing conventions. This means it's intentionally generalised so it can apply across most C‑influenced languages and common data formats, including Java, Objective‑C, JavaScript, TypeScript, Python, JSON, and XML.
We maintain the philosophy that a coding standard strictly avoids discussing or making recommendations towards code design and architecture.
For those topics, you can consider reading up on best practices and generally follow an existing project's conventions.
That being said, we believe your code should holistically prioritise the following philosophies:
- Readability
- Simplicity
- Usability
- Maintainability
- Dependability
- Cross-platform compatibility
Our hope is that your interpretation of those descriptors towards code design becomes more conscientious over time.
Please note that efficiency is deliberately omitted. Only make changes for efficiency after measuring the performance with A/B Testing (prove it!), and be sure the changes do not sacrifice anything from the list above.
Outside of the scope of this coding standard are some concepts better described by external sources:
On your first read of the coding standards, it is suggested to get the overall feel of the style by going through the following sections firstly, in the order listed.