Coding Style Guide

Establish a formal coding style guide. This makes it easier to read, reuse, and debug code. Gives customers a level of comfort because they know what to expect when getting code. Also provides consistency around security and performance.

Some examples to follow:

Google Java Style Guide

The Apache Groovy programming language - Style guide

Using an example already in the wild means that people from outside the company can come in and understand the style guide already. This makes very popular ones, such as Google’s, attractive to implement.

When implementing a style guide, it is not enough to tell your engineers to use the style guide, but style has to be enforced when coding.

For Amelia purposes, this can exist in one of two ways:

  1. In the Amelia script editor UI
  2. As a VSCode plugin

Option #1 will require buy in from R&D to bake that into the platform.

Option #2 requires going outside the platform, but allows us to utilize already existing plugins to enforce style.

Groovy Formatters

Groovy Linters