[CASSANDRA-18090] Cassandra code style and static analysys

• Type: Epic
• Status: Triage Needed
• Priority: Normal
• Resolution: Unresolved
• Epic Name: Code Style & Static Analysis
• Platform: All
• Assignee: Unassigned Assign to me
• Reporter: Maxim Muzafarov
• Created: 04/Dec/22 20:05
• Updated: 22/Feb/24 20:53

Description

This is an umbrella ticket that aggregates all activities related to improving code style guides as well as adding new tools for code analysis.

Despite the fact that expanding the code style rules and adding such checks to the source code may take a long time, the main goals for this epic are:

• add a static code analysis automatic checks support (SpotBug) to the build;
• in terms of automatic code checking make GitHub pull requests more convenient;
• update the checkstyle configuration;

Cassandra code style guide:
https://cassandra.apache.org/_/development/code_style.html
https://cwiki.apache.org/confluence/display/CASSANDRA2/CodeStyle

Discussion Code style and static analysis on the dev list:
https://lists.apache.org/thread/11j0hrv2bkx60xk7zvlgqgjwo982qv6h

Discussion Add SpotBugs to the build on the dev list:
https://lists.apache.org/thread/1ro1mvkpvt4vr24nw7dbpdlxo82mq3hz