Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 2.25 KB

Contributing

Issues

Please read these guidelines before opening an issue. If you still need to open an issue then we ask that you complete the template as fully as possible.

Pull requests

We welcome pull requests, but ask contributors to keep in mind the following:

  • Only PRs with the template completed will be accepted
  • We will not accept PRs for user specific functionality

Developer Certificate of Origin

In order for us to accept pull-requests, the contributor must sign-off a Developer Certificate of Origin (DCO). This clarifies the intellectual property license granted with any contribution. It is for your protection as a Contributor as well as the protection of IBM and its customers; it does not change your rights to use your own Contributions for any other purpose.

Please read the agreement and acknowledge it by ticking the appropriate box in the PR text, for example:

  • Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1

General information

Cloudant-spring is written in Java and uses Gradle as its build tool.

Projects

There are two sub-projects in cloudant-spring each of which produces an artifact for publishing.

cloudant-spring-boot-starter

The cloudant-spring-boot-starter jar provides a custom Spring autoconfiguration for a com.cloudant.client.api.CloudantClient bean, com.cloudant.client.api.ClientBuilder bean and com.cloudant.client.api.Database bean.

cloudant-spring-framework

The cloudant-spring-framework jar provides a custom annotation called com.cloudant.spring.framework.EnableCloudant which when applied provides a com.cloudant.client.api.CloudantClient bean and com.cloudant.client.api.ClientBuilder bean.

Requirements

  • gradle
  • Java 1.8

Installing requirements

Java

Follow the instructions for your platform.

Gradle

Gradle 8.1 or higher is required.

Building

The project should build out of the box with:

$ gradle build

Testing

Running the tests

The tests run using Mockito to mock the Cloudant client:

$ gradle test