Skip to content

Commit 466d08f

Browse files
docs: update CONTRIBUTING.md to include code formatting (#534) (#315)
Co-authored-by: Jeff Ching <chingor@google.com> Co-authored-by: Jeffrey Rennie <rennie@google.com> Source-Author: Brian Chen <chenbrian@google.com> Source-Date: Tue May 12 10:24:59 2020 -0700 Source-Repo: googleapis/synthtool Source-Sha: 5b48b0716a36ca069db3038da7e205c87a22ed19 Source-Link: googleapis/synthtool@5b48b07
1 parent 16487f1 commit 466d08f

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

CONTRIBUTING.md

+10-1
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

synth.metadata

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/java-storage.git",
7-
"sha": "5566daf02b6584231cfa5fcc9cf624f398ff29e0"
7+
"sha": "16487f197ddb047c84d80674b8a60efe13feeceb"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "98c50772ec23295c64cf0d2ddf199ea52961fd4c"
14+
"sha": "5b48b0716a36ca069db3038da7e205c87a22ed19"
1515
}
1616
}
1717
]

0 commit comments

Comments
 (0)