Summary

Our codebase has accumulated different various code styles over many years with no single agreed reference, so the same construct is often written several different ways depending on when it was added.

The target of this epic is creating a single human-readable style guide for the driver, and we want to enforce as many of its rules as possible automatically through tooling, so that violations break the build rather than depending on a reviewer noticing them. For the rules that can't be automated, we want an AI reviewer to check them at PR time. 

Motivation

Who is the affected end user?

N/A

How does this affect the end user?

N/A

How likely is it that this problem or use case will occur?

N/A

If the problem does occur, what are the consequences and how severe are they?

N/A

Is this issue urgent?

N/A

Is this ticket required by a downstream team?

N/A

Is this ticket only for tests?

N/A

Cast of Characters

Engineering Lead:
Document Author:
POCers:
Product Owner:
Program Manager:
Stakeholders:

Channels & Docs

Slack Channel

[Scope Document|some.url]

[Technical Design Document|some.url]