codeStandard.md

All of these code standards should be applied at all times.

table

1. Naming

• 1. Functions and Classes
• 2. Variables

2. Commenting and Documentation

• 1. Comments
• 2. Documentation

3. Code Structure and Organization

• 1. Consistent Indentation
• 2. File and Directory Structure

4. Avoiding Magic Numbers and Strings
5. Code Reusability

Naming

Functions and classes

Use PascalCase

Variables

Use camelCase

Commenting and Documentation

Comments

Use comments to explain the "why" and not the "what".

Documentation

Use JSDoc to document classes and functions if they return a value

Code Structure and Organization

Consistent Indentation

Use Indent using Tabs with a tab size of 4. if you do not have Prettier installer already, install it now. Installing Prettier ensures that the code remains consistent.

File and Directory Structure

Place your code in "src" and images, svg and other files in "public".

Avoiding Magic Numbers and Strings

Code Reusability

Strive for DRY (Don't Repeat Yourself) principles by abstracting reusable code into classes, functions or variables.

Tools

• Better Comments
• Code Spell Checker
• GitLens — Git supercharged
• Prettier