Skip to content

ratehub/code-style

Repository files navigation

RateHub Coding Style Guide

An opinionated style guide which aims to improve readability and maintainability of code within RateHub

Goals

  • attempt to follow idiomatic practices and style patterns of a particular language/ecosystem.
  • proactively improve maintainability of code by looking for known anti-patterns or "hacky" solutions.
  • reduce time to understand a file by enforcing a shared style within a code base.
  • encourage developers to find simple, maintainable solutions to problems.

Layout

Each folder contains a listing of the rules chosen, and some background about why it is seen as undesirable