CODE_STYLE_GUIDE.md

Code Style Guide

This document outlines the coding style and conventions that we follow in our repository. Following these guidelines will help ensure consistency and readability in our codebase.

General Guidelines

Code should be written in English.

• Use descriptive variable and function names.
• Use comments to explain code that might not be immediately clear to others.
• Keep code concise and readable.
• Write code that is easy to understand, modify, and maintain.

Naming Conventions

Variables

• Use descriptive names that convey the purpose of the variable.
• Use camelCase for variable names.
• Avoid using single-letter variable names unless the context makes the purpose clear.

Functions

• Use descriptive names that convey the purpose of the function.
• Use camelCase for function names.
• Prefix functions that are private or should not be called outside of their class with an underscore (_).

Classes

• Use descriptive names that convey the purpose of the class.
• Use PascalCase for class names.

Code Formatting

• Use 4 spaces for indentation.
• Use single quotes (') for strings unless you need to use a single quote within the string.
• Use semicolons (;) to end statements.
• Use one statement per line.
• Use blank lines to separate logical blocks of code.

Conclusion

Following these guidelines will help ensure that our codebase is consistent and readable. Thank you for your contribution to our repository and for following our code style guide!