Code Style Guide

Introduction

This document outlines the code style guidelines for the Comty project. The goal of these guidelines is to create readable, consistent, and maintainable code across the entire codebase.

General Principles

Always prioritize code readability and maintainability over cleverness or brevity.
Write code that is easy to understand by other developers and your future self.
Follow established patterns and conventions in the codebase, even if it means deviating from personal preferences.
Write code that is compatible with the latest stable version of the language being used.
Refactor code as needed to maintain readability and avoid duplication.

Language-specific Guidelines

JavaScript

Do's

Use ES6 syntax and features whenever possible.
Use double quotes for strings, including for JSX.
Use const and let instead of var.
Always use strict equality (=== and !==) for comparisons.
Use a CSS preprocessor like LESS. (We recommend use LESS cause it's used in the project, we prefer to no include another dependency)
Use the :hover, :focus, and :active pseudo-classes as needed.
Use descriptive class and ID names that clearly indicate their purpose.
Use a consistent naming convention for classes and IDs, and avoid using inline styles.

Dont's

Don't include unnecesary logs over the console.
Don't declare unnecesary variables.
Avoid using eval() and with().

Format

Use tabs for indentation. (tab_width: 2)
Use kebab-case for ID names.
Use camelCase for variable and function names.
Use PascalCase for class and component names.

Preferably use prettier to format all the code, the configuration file is included in the repository.

Conclusion

By following these code style guidelines, we can create code that is easy to read, understand, and maintain. These guidelines are not exhaustive, and there may be cases where they don't apply or conflict with other guidelines. In such cases, use your best judgement and work with the team to come to a consensus.

2.0 KiB Executable File Raw Blame History