public-conventions icon indicating copy to clipboard operation
public-conventions copied to clipboard

In-house conventions and styles

Octopus Energy conventions

This doc details house conventions for code written at Octopus Energy.

"Everyone is happier when the code we interact with is clean and consistent. Even if it doesn't match your own style perfectly, consistency is the most important thing." Chris Coyier

It is intended to be a reference that can be linked to in code-review comments, similar to the Go code review comments guide.

Contents:

  • Python
  • Python architecture patterns
  • Git
  • CSS
  • HTML and Django templates
  • GraphQL
  • Email templates
  • Emoji shorthand (used in code-review and Slack messages)
  • Terraform