15,000 USDC
View results
Submission Details
Severity: low

Unconventional Variable names in code

Summary

The variable name in the src folder violates a common programming convention where private or internal variables should begin with an underscore (_).

Vulnerability Details

Although this isn't a technical vulnerability that might result in program failures or security flaws, it does carry implications for code clarity. Failure to adhere to this convention may lead to confusion, particularly in larger codebases or when other developers are reading or working on your code. Variables that are not appropriately signalized as private or for internal use only might be used in unanticipated ways, potentially causing obscure issues and increasing debugging effort.

Impact

Disregarding this convention doesn't inherently induce bugs, but the possible ambiguity in code understanding and the misuse of variables might unintentionally result in coding errors. In terms of project management, this lack of readability and the increased chances of misunderstanding could have a meaningful impact on the project's timeline and efficiency.

Tools Used

EthLint tool

Recommendations

To minimise the potential for confusion and to make the codebase more maintainable and readable:

  • follow the convention of prefixing private or internal variables with an underscore (_ ).

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.