From 04f8b3b0f873c2f1988c184de1e5268e0de9053f Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Mon, 11 May 2020 11:08:47 -0700 Subject: [PATCH] docs: update README to include code formatting (#209) --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 085021dde..7e3c60a73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,6 +101,15 @@ mvn -Penable-samples clean verify 2. [Activate](#profile-activation) the profile. 3. Define your samples in a normal Maven project in the `samples/` directory +### Code Formatting + +Code in this repo is formatted with [google-java-format] +(https://github.com/google/google-java-format). +To run formatting on your project, you can run: +``` +mvn com.coveo:fmt-maven-plugin:format +``` + ### Profile Activation To include code samples when building and testing the project, enable the