Code conventions

Backend

We are following conventions described in Effective Go document.

Go to our Go Report Card to check how well we are doing.

We are following conventions described in Angular Style Guide and Material Design Guidelines.

Additionally, check the list of rules and tips, that we are using:

Private method and variable names should end with a _.
In order to keep all tooltips consistent across whole application, we have decided to use 500 ms delay and auto-hide option. It allows us to avoid flickering when moving the mouse over the pages and to hide tooltips after the mouse is elsewhere but the focus is still on the element with tooltip.

An overview of the features provided by the dashboard can be found here.

The code style check suite includes format checks can be executed with:

make check

The code formatting can be executed with:

make fix

These check and formatting involves in go, ts, scss, html, license and i18n files.

We use following tools and settings for each check and formatting:

code	tools	setting
go	golangci-lint	`.golangci.yml`
ts	gts	`.eslintrc.yaml` and `.prettierrc.js`
scss	stylelint	`.stylelintrc.yaml`
html	prettier	`.jsbeautifyrc`
license	license-check-and-add	`license-checker-config.json`
i18n	xliffmerge	`xliffmergeOptions` in `package.json`