Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update README to include code formatting #209

Merged
merged 2 commits into from May 11, 2020
Merged

docs: update README to include code formatting #209

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5988dd4
docs: update README to include code formatting
May 8, 2020
ca23e20
rerun CI
May 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Expand Up @@ -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
Expand Down