fe-code-style

Diagnose and fix Java code style violations in the Doris FE module using Checkstyle.

15.8k|3.9k|Updated Aug 10, 2017

Search Tags:#linting #code style #maven #build validation #checkstyle #apache doris #JAVA

One-click install

npx skills add https://github.com/apache/doris --skill fe-code-style

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: fe-code-style
Source: https://github.com/apache/doris/tree/main/.claude/skills/fe-code-style
Command: npx skills add https://github.com/apache/doris --skill fe-code-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

FE Java code contributions to Apache Doris fail the Maven build when they violate Checkstyle rules, and developers often struggle to interpret violation messages, locate the right configuration files, and apply the correct fixes before committing.

Core Features & Use Cases

Checkstyle Execution Guidance: Run style checks standalone via mvn checkstyle:check -pl fe-core or as part of the full FE build.
Violation Interpretation and Fixes: Map common violations (RegexpHeader, UnusedImports, LineLength, IllegalImport, FileTabCharacter) to concrete fixes.
Configuration Reference: Locate and understand checkstyle.xml, suppressions.xml, import-control.xml, and the IntelliJ formatter scheme.
Use Case: Before committing a change to the FE module, run the checkstyle goal, read the reported file and line violations, apply the documented fixes such as adding the Apache license header or removing shaded imports, and re-run to verify a clean build.

Quick Start

Check my FE Java changes for Checkstyle violations and help me fix any reported style issues before I commit.

Frequently Asked Questions about fe-code-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I make IntelliJ formatting match Doris Checkstyle rules?▼

Import the build-support/IntelliJ-code-format.xml scheme via Settings, Editor, Code Style. It configures the 120-column limit and import organization so IDE formatting aligns with the Checkstyle rules.