apache / apache/pinot

Set up a pipeline or maven plugin to enforce java format

Open
#6,727 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
6.1k
Forks
1.5k
Avg merge
1d 21h
Merged PRs (30d)
189

Description

As discussed in https://github.com/apache/incubator-pinot/pull/6721

>There are lots of files are not formatted properly, engineers often forget to format it before commit. We need either setup a Github workflow/pipeline, or a maven plugin to enforce java format

Some tools may be useful:

CLI tools:
* https://github.com/google/google-java-format

Maven plugins:
* https://github.com/diffplug/spotless/tree/main/plugin-maven
* https://github.com/coveooss/fmt-maven-plugin
* https://github.com/talios/googleformatter-maven-plugin
* https://github.com/Cosium/git-code-format-maven-plugin

Contributor guide

Open the contributing guide

Research direction

Start by inspecting Pinot's Maven build configuration and GitHub workflow setup, then compare the listed google-java-format and Maven plugin options. Choose one enforcement path, configure it for the Java sources, and verify that the existing repository passes the formatting check.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.