client-java/dev
iosmanthus 9ce52d3401
[to #555] enable api v2 (#575)
2022-06-02 16:33:28 +08:00
..
README.md [to #421] add a python script to analyze slow log stats (#527) 2022-02-22 15:52:02 +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
proto.sh [to #555] enable api v2 (#575) 2022-06-02 16:33:28 +08:00
spotbugs-include.xml [close #415] add spotbugs in github actions (#502) 2022-02-16 10:30:44 +08:00

README.md

TiKV Java Client Dev Tools

Code Formatting

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