Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

25 lines (15 loc) · 1.59 KB
Raw

Contributing

Instructions for contributing to plaid-java. A java client library for the Plaid API. This library is fully generated from the Plaid OpenAPI spec.

This library cannot directly accept PRs from the public as it is generated from internal Plaid sources on the internal Plaid GitHub instance and any changes made directly to this repo will be overwritten. If you submit a PR and it is accepted, a member of Plaid engineering will copy and paste your change into the upstream, internal version of this repo rather than merging your PR.

Plaid employees should make any changes on the internal Plaid GitHub and not on the public repo.

Setup

If you find an issue, please investigate whether it is a type problem with OpenAPI or a problem with the java generator. Then open an issue and Plaid will investigate further.

Running Tests

  1. To build the docker image for the client tests, run docker build -t plaid-java ..
  2. Go to the Plaid Dashboard and copy and paste your client_id and sandbox secret into the following command.
  3. Run docker run --rm -e PLAID_CLIENT_ID=$CLIENT_ID -e PLAID_SECRET=$SECRET plaid-java.

If you wish to run a single test, edit the Dockerfile CMD and add a parmeter like so: CMD ["mvn", "-Dit.test=IdentityGet*", "-Dmaven.javadoc.skip=true", "verify", "-e"]

Then rebuild the docker image using the command from step 1.