Skip to content

Repository style guide

TL;DR

We use prettier code style, conventional commit messages, and cspell spelling to ensure basic code quality. All commits run tests on CI servers. Those tests include typechecking using Microsoft's TypeScript, checking prettier code style, and linting with eslint and typescript-eslint.

  • Use prettier code style.
  • Use conventional commit messages.
    • We recommend using commitizen to make commit messages easier.
      • This repository is not yet commitizen friendly, check back soon!
  • Use US spelling.
    • We check spelling with cspell. If cspell throws an incorrect spelling error, you may add the word to the words array in the top-level .cspell.json config file.
Important

We use husky to enforce critical parts of this style guide. Husky will prevent a git commit from occurring with non-prettier code or a malformed commit message.

Last update: April 18, 2022
Created: April 18, 2022
Back to top