All newly developed code must adhere to the standards outlined in this document. This directive guarantees that new projects and features are built to the highest standards of quality, consistency, and security. By following these guidelines from the beginning of a project, it becomes easier to maintain, scale, and integrate with existing systems.
Even when modifying or extending legacy code, it is important to keep these standards in mind. Developers are encouraged to:
-
Evaluate and Update: Whenever possible, existing code that undergoes significant modifications should be brought into compliance with these standards. This approach allows for gradual improvement of the codebase and simplifies future maintenance efforts.
-
Balance and Considerations: Understand that strictly applying new standards to old code may not always be feasible or practical due to dependencies, complexity, or the risk of introducing errors. In such cases, developers should strive to strike a balance between adhering to the standards and maintaining the integrity and functionality of the existing codebase.
-
Document and Review: Any deviations from these standards, particularly when working with legacy code, must be documented and justified. This documentation will be reviewed during the code review process, ensuring that exceptions are made with careful consideration and for valid reasons.
By following these practices, we not only prioritize the quality of new code but also make dedicated efforts to improve and standardize our existing codebase over time. This aligns with our organizational commitment to excellence in software development.