vesoft-inc / vesoft-inc/nebula-java

Use spotless to format code to standard

Open
#485 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/enhancement
Dominant language
Java
Stars
199
Forks
125
Avg merge
5h 6m
Merged PRs (30d)
3

Description

Its great to have checkstyle for a community project its even better if the build can format the code to the standard.

My suggestion would be to use spotless
https://github.com/diffplug/spotless/tree/main/plugin-maven

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the existing Checkstyle configuration and Maven build, then review the Spotless Maven plugin documentation linked in the issue. Define how formatting should integrate with the build and what standard it should enforce; done means the project can format code consistently without conflicting with Checkstyle.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.