search

COOL-cohort / COOL

the source code of the COOL system
https://www.comp.nus.edu.sg/~dbsystem/cool/
Apache License 2.0
44 stars 15 forks source link

Add checkstyle and overall cleaning #102

Closed hugy718 closed 1 year ago

hugy718 commented 1 year ago

This PR adds a checkstyle file that should respected by all committers in the future for code formatting.

hugy718 commented 1 year ago

@KimballCai @Zrealshadow @NLGithubWP @liuchangshiye I have cleaned the cool-core directory. Fixed the indentation, variable names, imports, and missing java docs on public APIs. Please use the cool-checkstyle.xml file in your code editor for future development, and do a rebase to the dev branch, once this PR is merged.

An github action is deployed to invoke checkstyle to check the formatting on added/modified files for future PRs.

Cleaning of the other folders, namely cool-example, cool-extensions and cool-queryserver will be done later, as they do not affect ongoing developments we discussed in recent weeks.

KimballCai commented 1 year ago

Besides, could you share the coding style file? to define the indent and others?

hugy718 commented 1 year ago

Besides, could you share the coding style file? to define the indent and others?

It is called cool-checkstyle.xml file under the root directory of this project. It is modified based on the Google Java coding style built-in configuration in checkstyle. I relaxed some naming rules to better suit our code base.