Skip to content

Commit 36507f8

Browse files
a49apan3793
authored andcommitted
[KYUUBI #2148][DOCS] Add dev/reformat usage
### _Why are the changes needed?_ Add a `dev/reformat` usage in `developer.md`. ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #2149 from deadwind4/reformat-doc. Closes #2148 0457d87 [Ada Wong] fix typo 67af7e4 [Ada Wong] [KYUUBI #2148][DOCS] Add dev/reformat usage Authored-by: Ada Wong <rsl4@foxmail.com> Signed-off-by: Cheng Pan <chengpan@apache.org>
1 parent 95fc6da commit 36507f8

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/develop_tools/developer.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,15 @@ Kyuubi uses the `dev/dependencyList` file to indicate what upstream dependencies
4646

4747
For Pull requests, a linter for dependency check will be automatically executed in GitHub Actions.
4848

49-
5049
You can run `build/dependency.sh` locally first to detect the potential dependency change first.
5150

5251
If the changes look expected, run `build/dependency.sh --replace` to update `dev/dependencyList` in your Pull request.
52+
53+
54+
## Format All Code
55+
56+
Kyuubi uses [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-maven)
57+
with [google-java-format](https://github.com/google/google-java-format) and [Scalafmt](https://scalameta.org/scalafmt/)
58+
to format the Java and Scala code.
59+
60+
You can run `dev/reformat` to format all Java and Scala code.

0 commit comments

Comments
 (0)