janniklinde opened a new pull request, #2392: URL: https://github.com/apache/systemds/pull/2392
This patch aims to improve codestyle consistency for future contributions. There are two main issues with contributions to SystemDS: 1. Some codestyles are enforced, but there is no automatic check to enforce that style before manual review (e.g., unused imports, wildcard imports, tabs vs spaces) 2. Contributions introduce inconsistent code styles (e.g., variable naming; `private int _x` or `private int x`, or spacing in control flow) To improve consistency, a `checkstyle.xml` was added as a build plugin. This file contains mandatory codestyle checks such as: - Required leading tabs and not spaces (except in comments) - Unused imports detection - Wildcard imports detection - Some naming conventions (e.g., type names) To allow incremental codestyle improvements, existing failing codestyle checks are suppressed in `suppressions.xml`. While some naming conventions are already enforced in this patch (such as method name and type names), some have been disabled because there are no clear guidelines and must yet be discussed. I would particularly be interested in leading underscores in member variables, which currently differ from class to class and are sometimes inconsistent even within the same class. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
