Skip to content

Commit 5b48b07

Browse files
Brian Chenchingor13SurferJeffAtGoogle
authored
docs: update CONTRIBUTING.md to include code formatting (#534)
Co-authored-by: Jeff Ching <[email protected]> Co-authored-by: Jeffrey Rennie <[email protected]>
1 parent a7759f8 commit 5b48b07

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

synthtool/gcp/templates/java_library/CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,16 @@ mvn -Penable-samples clean verify
9999
```
100100

101101
2. [Activate](#profile-activation) the profile.
102-
3. Define your samples in a normal Maven project in the `samples/` directory
102+
3. Define your samples in a normal Maven project in the `samples/` directory.
103+
104+
### Code Formatting
105+
106+
Code in this repo is formatted with
107+
[google-java-format](https://github.com/google/google-java-format).
108+
To run formatting on your project, you can run:
109+
```
110+
mvn com.coveo:fmt-maven-plugin:format
111+
```
103112

104113
### Profile Activation
105114

0 commit comments

Comments
 (0)