Style guide for repositories

Style guide for repositories#

We use pre-commit to automatically enforce certain styles across our infrastructure repository. You can view the full configuration in the .pre-commit-config.yaml file. These tools have been agreed upon by the engineering team and can be applied to a new repository under the 2i2c organisation as a team member sees fit.

A short summary of the tools and the file types they affect are given in the table below.

File type

Tools

Markdown

prettier

YAML

prettier

Python

black, flake8, pyupgrade