clean-code

Apply clean code principles by adhering to single responsibility, DRY, KISS, and YAGNI rules to maintain code quality, enhance readability, and simplify future maintenance.

Maintainable functions require keeping them small and focused on one task, while naming conventions for variables, booleans, and constants must be clear and consistent to reduce complexity.

Use coding standards to guide AI-assisted code review by enforcing direct implementation, minimal comment overhead, and structural best practices to ensure clarity.

You do not need any dependencies to run the pre-edit check; simply execute the Python script directly before making changes to evaluate your code quality.

Eliminate unnecessary comments and over-engineering to ensure your codebase remains concise, direct, and maintainable, preventing bloated logic and reducing future technical debt.

Avoid using the Boy Scout rule when a module requires massive architectural changes, as small incremental cleanups might conflict with broader structural redesigns and destabilize the system.