This folder contains shared code, resources, and utility functions that are used across different parts of the project. By placing shared resources in this folder, we can maintain a DRY (Don't Repeat Yourself) approach and avoid duplicating code.
The Common Directory is organized into the following sub-folders:
src
: Contains the source code for shared utility functions, types, and other resources that are used throughout the project.
The Common Directory is responsible for:
- Providing shared utility functions and resources.
- Ensuring a DRY approach to code organization.
- Encouraging code reusability across different parts of the project.
When working with the Common Directory, follow these best practices:
- Place shared code, resources, and utility functions in the
/common/src
folder. - Keep the Common Directory focused on providing reusable components that can be used across the project.
- Avoid adding project-specific or environment-specific configurations in the Common Directory.
When adding new functionality to the Common Directory, ensure that you:
- Follow the existing project structure and organization.
- Update this README.md file if needed.
- Write tests for new components and functionality.
- Adhere to the project's coding style and best practices.