client-java/dev/README.md

866 B

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