conventions.md
July 1, 2025 ยท View on GitHub
Git commits conventions
We're using husky git hooks in combination with commitlint according to https://commitlint.js.org/concepts/commit-conventions.html#concept-commit-conventions:
type(scope?): subject
body?
footer?
Type must be one of the following:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
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.
prettier
The prettier tool provides a general code prettifying.
Linting
xo
The xo tool provides a general code linting mechanism.
yaml files via yamllint
The prettier tool provides a general code prettifying.