Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.3 KB

conventions.md

File metadata and controls

35 lines (21 loc) · 1.3 KB

Git commits conventions

We're using husky git hooks in combination with commitlint according to https://commitlint.js.org/#/concepts-commit-conventions:

type(scope?): subject
body?
footer?

Type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]

source: commitlint documentation

If you'd like to test your commit message previous to using it, you could test it on the command line:

echo 'foo: bar' | commitlint

Code conventions

The general code conventions are guaranteed by the following tools.

Through configuration files: .editorconfig for IDEs and .gitattributes for git checkins

Both the .editorconfig and .gitattributes ensure a consistent code structure and conventions through their configurations.

xo

The xo tool provides a general code linting mechanism.

prettier

The prettier tool provides a general code prettfying.