tikv
/
client-java
mirror of https://github.com/tikv/client-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
client-java/dev
History
iosmanthus 4f33307b99
[close #415] add spotbugs in github actions (#502) 
Co-authored-by: ti-srebot <66930949+ti-srebot@users.noreply.github.com>
 		2022-02-16 10:30:44 +08:00
..
README.md Reform java client to combine with TiSpark's java client (#91) 2020-10-21 19:10:18 +08:00
intellij-java-google-style.xml [close #505] add xml formatter and check in CI (#506) 2022-02-15 09:18:31 +08:00
javafmt [close #505] add xml formatter and check in CI (#506) 2022-02-15 09:18:31 +08:00
spotbugs-include.xml [close #415] add spotbugs in github actions (#502) 2022-02-16 10:30:44 +08:00

README.md

TiSpark Dev Tools Guide

Formatting

Java Format

TiKV Java Client formats its code using Google-Java-Format Maven Plugin which follows Google's code styleguide. It is also checked on CI before build.

  1. In Intellij IDEA

    1. you should download the Google-Java-format Plugin via marketplace. Restart IDE, and enable google-java-format by checking the box in Other Settings.

    2. you may also use Java-Google-style xml file and export the schema to Intellij:

      Preferences->Editor->Code Style->Import Scheme->Intellij IDEA Code Style XML.

  2. You may also run Java format script before you commit & push to corresponding dev branch.

    ./dev/javafmt