Coding standards and guidelines

A collection of standards for development at Companies House. See Confluence for which version of software to use (internal CH link).

You can use the checklists to support ensuring a repository is up to scratch and meeting the latest repository standards.

General

• Service Naming
• .gitignore
• accessibility
• Health checks
• Feature flags
• READMEs
• Environment variables
• Logging

Languages

• Bash
• Go
• Java
• Java Review
• JavaScript (Node)
• JavaScript (Chips)
• Java Server Pages (JSP)
• Perl
• Terraform
• Common standards

Tools

• Concourse Pipelines
• Git
• Makefiles
• Maven
• Perl POD

Linting

This repository is linted using Markdownlint. If you have docker installed and logged into the shared services ECR repository you can run these checks locally:

make markdownlint

OR

make markdownlint_file MARKDOWN_FILE=<...>.md

(Where <...> is the name of the file to be linted.)

Running the following will attempt to fix any of the markdownlint failures for you. (You may still have some like long lines to fix manually.)

FIX_MARKDOWN=true make markdownlint