Codebase update to PSR12 coding standard #272

New issue

Closed

opened 2023-07-08 03:36:00 +00:00 by jamie · 2 comments

jamie commented

2023-07-08 03:36:00 +00:00

(Migrated from git.hazaar.io)

Summary

The current codebase in DABOM follows an inconsistent coding style, making it challenging to read, understand, and maintain the code. To improve code quality, readability, and maintainability, it is proposed to refactor the entire codebase to adhere to a new coding standard, specifically PSR-12.

Area of the system

The change will impact the entire codebase of the DABOM application.

How does this currently work?

Currently, the codebase does not follow a consistent coding standard. Coding styles, naming conventions, and formatting vary across different sections of the codebase, making it harder for developers to work together and understand the code.

What is the desired way of working?

The desired way of working involves the following changes:

Adopt the PSR-12 coding standard as the new coding style guide for the entire codebase.
Refactor existing code files to adhere to the PSR-12 standard, including naming conventions, coding style, indentation, and documentation practices.
Establish clear guidelines and best practices for future code contributions to maintain consistency and readability.
Conduct code reviews and provide feedback to ensure compliance with the PSR-12 standard.
Update relevant documentation and guidelines to reflect the new coding standard.

Priority/Severity

High (This change will significantly improve code quality, readability, and maintainability)
Medium (This change will enhance consistency and collaboration among developers)
Low (Considered a minor improvement, not critical for functionality)

## Summary The current codebase in DABOM follows an inconsistent coding style, making it challenging to read, understand, and maintain the code. To improve code quality, readability, and maintainability, it is proposed to refactor the entire codebase to adhere to a new coding standard, specifically PSR-12. ## Area of the system The change will impact the entire codebase of the DABOM application. ## How does this currently work? Currently, the codebase does not follow a consistent coding standard. Coding styles, naming conventions, and formatting vary across different sections of the codebase, making it harder for developers to work together and understand the code. ## What is the desired way of working? The desired way of working involves the following changes: 1. Adopt the PSR-12 coding standard as the new coding style guide for the entire codebase. 2. Refactor existing code files to adhere to the PSR-12 standard, including naming conventions, coding style, indentation, and documentation practices. 3. Establish clear guidelines and best practices for future code contributions to maintain consistency and readability. 4. Conduct code reviews and provide feedback to ensure compliance with the PSR-12 standard. 5. Update relevant documentation and guidelines to reflect the new coding standard. ## Priority/Severity - [ ] High (This change will significantly improve code quality, readability, and maintainability) - [x] Medium (This change will enhance consistency and collaboration among developers) - [ ] Low (Considered a minor improvement, not critical for functionality)

jamie commented

2023-07-08 03:36:00 +00:00

(Migrated from git.hazaar.io)

assigned to @jamie