Coding guidelines - mindarc/frontend-assessment GitHub Wiki

Naming convention

General

Avoid abbreviations

Avoid abbreviations because they can be subjectively interpreted and unnecessarily increase cognitive overhead. There are some exceptions such as block indices.

Booleans

Booleans should start with either is or has and should make english sense.

Styling

  • Casing: kebab-case
  • Use BEM syntax for custom CSS classes.
  • Use Tailwind
  • Use CSS/SCSS instead of utility classes for reused components. But this doesn't mean you can't use both, consider what will always be the same (CSS) and what may change e.g. spacing around the element (utility classes).

JavaScript

  • Casing: camelCase

Thanks for reading!