Skip to main content

Coding Standards

This document outlines the coding standards and best practices that we follow in our projects.

General Practices​

Code Formatting​

To maintain consistency in coding styles across different environments, we use Prettier for code formatting.

You can format your code by running the command pnpm format in your terminal. Alternatively, you can install the Prettier VSCode extension.

tip

If you are using the VSCode extension, you can enable the "Format On Save" (editor.formatOnSave) option to automatically format your code every time you save a file.

Linting​

We use ESLint for linting our code. ESLint helps us identify and fix common errors and enforce coding standards.

You can lint your code by running the command pnpm lint in your terminal. Alternatively, you can install the ESLint VSCode extension.

Architecture​

Our codebase is structured around the concept of modules, which helps in organizing code into distinct features or components. This approach enhances scalability, maintainability, and reusability of code.

note

TODO: Add more detailed information on our architecture and modular approach.

Style Guide​

For specific coding conventions and best practices, we refer to established style guides until we develop our own detailed guide. Please adhere to these guides for writing consistent and high-quality code: