1. General formatting guidelines

1.1. Encoding

All code must be encoded in UTF-8.

Make sure your editor uses UTF-8 as character encoding, without a byte order mark.

All code must be indented using 2 spaces.

Don’t use tabs or mix tabs and spaces for indentation.

Included blocks of code should be indented with the same amount of spaces as the surrounding code.

All code must be less than 120 characters per line.

All code must use LF line endings.

Separate meaningful code blocks with a blank line.

Avoid unnecessary blank lines.

Text files should ends with a newline character, except for JSON files.

Remove trailing white spaces.

Trailing white spaces are unnecessary and can complicate diffs.

Explain code as needed, where possible.

Use comments to explain code: what does it cover, what purpose does it serve, why is respective solution used or preferred?

Mark todos and action items with @todo or @fixme keywords.

Append action items or descriptions after a colon as in @todo: action item because of reason.

// do something
/* will fix this later */

Avoid aligning code horizontally.

const a = {
  email:     'john.doe@example.com',
  firstName: 'John',
  lastName:  'Doe',
  age:       20,
};