How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Building the project

To build, package, and run all unit tests run the command

mvn clean verify

Running Integration tests

To include integration tests when building the project, you need access to a GCP Project with a valid service account.

For instructions on how to generate a service account and corresponding credentials JSON see: Creating a Service Account.

Then run the following to build, package, run all unit tests and run all integration tests.

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
mvn -Penable-integration-tests clean verify

Code Samples

Code Samples must be bundled in separate Maven modules, and guarded by a Maven profile with the name enable-samples.

The samples must be separate from the primary project for a few reasons:

Primary projects have a minimum Java version of Java 7 whereas samples have a minimum Java version of Java 8. Due to this we need the ability to selectively exclude samples from a build run.
Many code samples depend on external GCP services and need credentials to access the service.
Code samples are not released as Maven artifacts and must be excluded from release builds.

Building

mvn -Penable-samples clean verify

Some samples require access to GCP services and require a service account:

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
mvn -Penable-samples clean verify

Profile Config

To add samples in a profile to your Maven project, add the following to your pom.xml

<project>
  [...]
  <profiles>
    <profile>
      <id>enable-samples</id>
      <modules>
        <module>sample</module>
      </modules>
    </profile>
  </profiles>
  [...]
</project>

Activate the profile.
Define your samples in a normal Maven project in the samples/ directory.

Code Formatting

Code in this repo is formatted with 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 enable-samples Maven profile.

Command line

To activate the Maven profile on the command line add -Penable-samples to your Maven command.

Maven `settings.xml`

To activate the Maven profile in your ~/.m2/settings.xml add an entry of enable-samples following the instructions in Active Profiles.

This method has the benefit of applying to all projects you build (and is respected by IntelliJ IDEA) and is recommended if you are going to be contributing samples to several projects.

IntelliJ IDEA

To activate the Maven Profile inside IntelliJ IDEA, follow the instructions in Activate Maven profiles to activate enable-samples.