#3 Inconsistent Capitalization of Immutable and Constant Variable

Severity

Low Risk

Relevant GitHub Links

https://github.com/Cyfrin/2023-12-the-standard/blob/main/contracts/LiquidationPoolManager.sol#L12C4-L18C35

https://github.com/Cyfrin/2023-12-the-standard/blob/main/contracts/LiquidationPool.sol#L16C4-L18C38

https://github.com/Cyfrin/2023-12-the-standard/blob/main/contracts/SmartVaultV3.sol

Summary

In the context of code style and readability, consistency in naming conventions, including capitalization for immutable and constant variables, is considered good practice. While it may not be a critical issue regarding functionality or security, maintaining a consistent and clean coding style can make the code more readable and understandable for developers.

A consistent naming convention, such as following the same casing (camelCase, PascalCase, or other conventions) for immutable and constant variables, helps create a uniform look and feel across the codebase. This consistency can contribute to the maintainability of the code and make it easier for developers to follow and understand.

Impact

Most of the contracts in scope do this bad practice which can result in a bad view for the developers or even auditors. Span across: https://github.com/Cyfrin/2023-12-the-standard/blob/c12272f2eec533019f2d255ab690f6892027f112/contracts/SmartVaultV3.sol#L17C1-L24C50

https://github.com/Cyfrin/2023-12-the-standard/blob/c12272f2eec533019f2d255ab690f6892027f112/contracts/LiquidationPool.sol#L16C4-L18C38

https://github.com/Cyfrin/2023-12-the-standard/blob/c12272f2eec533019f2d255ab690f6892027f112/contracts/LiquidationPoolManager.sol#L12C4-L18C35

Tools Used

Manual review

Recommendations

Decide the kind of naming convention that would suit the entire codebase.