Coding Standards

Coding Standards

Use this Skill in exactly one of the following modes. Both modes derive compliance only from written standards that actually apply to the target files. For routing purposes, covered declaration annotations are HighFrequencyInvocation, AllArgsConstructor, RequiredArgsConstructor, NoArgsConstructor, Builder, Getter, Setter, EqualsAndHashCode, ToString, and Slf4j.

Implementation Guidance Mode

Use this mode when implementing, fixing, refactoring, or reviewing code, or when modifying or reviewing a Maven POM, unless the user explicitly requests a standalone coding-standards compliance audit. Read only the references whose conditions below match the affected files and task delta, and add each selected reference's applicable rules to one checklist grouped by governing file set.

• Before starting a read-only code review or making the first write in an implementation task, read the portions of CODE_OF_CONDUCT.md, repository-level and path-level AGENTS.md, Checkstyle, Spotless, and other written repository standards that actually apply to every affected file.
• For a changed or reviewed pom.xml, read Maven dependency version rules and apply them only to dependency declarations changed by the task.
• Read Java naming rules when the task adds or changes a field, local variable, parameter, lambda, returned-value temporary or direct return, or enhanced loop. When a type declaration or its type annotations change, read Java type rules.
• Before adding, changing, or reordering a covered declaration annotation, or when a Java declaration added or modified by the task contains at least two covered annotations, read the Java declaration annotation order rules through EOF and add each applicable rule to the checklist.
• Read Java constructor rules before changing an explicit or generated constructor or a field that may alter its signature or behavior.
• Before adding or changing a Java throw statement, a conditional branch that throws, a validation or precondition call, or a call to ShardingSpherePreconditions, read the Java precondition rules through EOF and add each applicable rule to the checklist.
• Before adding or changing a Java method annotated with lombok.SneakyThrows or changing the checked-exception behavior of such a method, read the Java exception handling rules through EOF and add each applicable rule to the checklist.
• Before adding or changing a Java declaration whose type is a java.util.Collection interface or implementation, read the Java collection declaration rules through EOF and add each applicable rule to the checklist.
• Before adding or changing a Java expression that copies Collections.singleton, Collections.singletonMap, or Arrays.asList into ArrayList, LinkedList, HashMap, or LinkedHashMap, read the Java collection rules through EOF and add each applicable rule to the checklist.
• Read Java expression rules before changing == or != when an operand may resolve to a named constant.
• Before adding or changing a multi-line Java declaration header, statement, or expression, or a Java physical line that may exceed 200 characters, read the Java line-wrapping rules through EOF and add each applicable rule to the checklist.
• For every affected Java test file, read the Java test code rules through EOF and add each applicable rule to the checklist.
• Read defensive-code rules before adding, changing, removing, or reviewing a defensive construct.
• Apply each rule according to whether its text governs existing code or only the current task delta, and never beyond authorized scope.
• After the last write, manually recheck the effective task delta and only the surrounding declarations needed to evaluate every applicable checklist rule.
• For Java, explicitly verify every applicable CODE_OF_CONDUCT.md coding rule, including declaration order; when a method uses private helpers, verify that those helpers immediately follow the caller and appear in the caller's call order, regardless of the caller's visibility.
• For Java, explicitly verify every applicable Java declaration annotation order rule against each declaration added or modified by the task.
• For Java, explicitly verify every applicable Java exception handling rule against each added or modified lombok.SneakyThrows annotation and the method bodies, invoked signatures, rethrown values, and contracts needed to resolve its exception types.
• For Java, explicitly verify every applicable Java collection declaration rule against the effective task delta and the operations, callers, callees, overrides, and contracts needed to determine the least-specific required declaration type.
• For Java, explicitly verify every applicable mutable-collection construction rule against the effective task delta and the operations, aliases, callers, callees, and contracts needed to determine whether mutability is required.
• For Java, when line-wrapping rules were selected, explicitly verify them against each applicable declaration header, statement, and expression added or modified by the task.
• For Java tests, explicitly verify every applicable Java test code rule against the effective task delta and the declarations and member types needed to resolve semantic applicability.
• Recheck every other selected rule only against the task delta and the context needed to decide applicability.
• Treat passing Checkstyle and Spotless as evidence only for the rules those tools enforce; neither result replaces the manual recheck.
• A later write invalidates final-check evidence only for affected files and rules; recheck those portions before verification or handoff.
• Do not invent rules from preference or nearby code, and do not report pre-existing violations outside task scope.
• Run the applicable formatting and standards checks required by the repository workflow.
• Do not run apply, format, or another file-modifying command unless the current task authority and repository rules authorize every possible write.
• Do not build a complete file inventory or perform physical-line accounting in this mode.

This mode constrains the current task; it is not a repository-wide audit.

Standalone Compliance Audit Mode

Use this mode only when the user explicitly asks for a coding-standards compliance audit of an exact file, package, Maven module, directory, or the whole repository. Keep the audit read-only and read the standalone compliance audit workflow through EOF; it defines reference selection, complete inventory, inspection, and reporting.

This Skill may inspect architecture, ownership, lifecycle, concurrency, and runtime paths only when those facts determine whether an applicable written coding standard is satisfied.