Coding Guidelines

Intro

This section contains guidelines for coding style and good programming practices used by this project. Please go to the source code organization page, to get a more accurate picture of the project

Names

• Use kebab-case for folders and files.
  • This approach is used to ensure compatibility between the various OS's, since in systems like Windows and Mac, the standard behavior is to be case-insensitive.
• Use camelCase for variables and constants.
• Use camelCase for functions and methods.
• Use camelCase for classes instances.
• Use PascalCase for classes declarations.
• Use PascalCase for types and interfaces.
• Use whole words in names when possible

Types

• Do not introduce new types or values to the global namespace

Comments

• Use JSDoc style comments.

Style

• Other coding styles will be handle by ESLint and Prettier.