Skip to content

Commit

Permalink
Some updates in readme and contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
maximevw committed Nov 19, 2023
1 parent 28eb4c0 commit 9ffb712
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
22 changes: 18 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ To run the tests, execute the following command:
```
mvn test
```
Regarding the tests, you need **Docker** installed on your machine.
Indeed, most of the tests in this project are based on
[Testcontainers for Cassandra](https://java.testcontainers.org/modules/databases/cassandra/), because testing a JDBC API
implementation requires ensuring that the driver is able to connect to a database and execute queries correctly.
For example, very common JDBC drivers like those for [PostgreSQL](https://github.com/pgjdbc/pgjdbc) or
[MS SQL Server](https://github.com/Microsoft/mssql-jdbc/) are also tested against a real database.

### Submit a pull request

Expand All @@ -63,12 +69,20 @@ Once your changes and tests are ready for review, submit them:
to verify it or simply run `mvn clean install` and check the logs).

3. Rebase your changes: update your local repository with the most recent code from the original repository, and rebase
your branch on top of the latest `release/next` branch. It is better that your initial changes are squashed into a
single commit. If more changes are required to validate the pull request, we invite you to add them as separate commits.
your branch on top of the latest `release/next` branch. It is better that your initial changes are squashed into a
single commit. If more changes are required to validate the pull request, we invite you to add them as separate
commits.

4. Finally, push your local changes to your forked repository and submit a pull request into the branch `release/next`
with a title which sums up the changes that you have made (try to not exceed 50 characters), and provide more details in
the body. If necessary, also mention the number of the issue solved by your changes, e.g. "Closes #123".
with a title which sums up the changes that you have made (try to not exceed 50 characters), and provide more details
in the body. If necessary, also mention the number of the issue solved by your changes, e.g. "Closes #123".

### About dependencies

If your changes require to add a new dependency or update an existing one, be sure to check these points first of all:
* the dependency is the latest stable version of the library compatible with JDK 8
* the dependency does not introduce vulnerabilities
* the version of the dependency is specified in a property `<artifactId>.version` in `pom.xml`.

### License headers

Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ To compile and run tests, execute the following Maven command:
mvn clean package
```

To build a bundled version of the JDBC wrapper, run the following command:
```bash
mvn clean package -Pbundle
```

#### Some considerations about running tests

If for some reason the tests using DataStax Enterprise server (`*DseContainerTest`) fail in your local environment, you
Expand Down Expand Up @@ -90,6 +95,17 @@ JetBrains DataGrip, you can have a look to the following links:
this example uses Astra JDBC driver (based on this project), so refer to the "Usage" section below to adapt driver
class and JDBC URL values.

This JDBC wrapper for Apache Cassandra® is also used to run
[Liquibase for Cassandra databases](https://github.com/liquibase/liquibase-cassandra) (from Liquibase 4.25.0). To execute Liquibase scripts on
your Cassandra database, specify the following properties in your Liquibase properties file:
```
driver: com.ing.data.cassandra.jdbc.CassandraDriver
url: jdbc:cassandra://<host>:<port>/<keyspaceName>?compliancemode=Liquibase
```
See the "Usage" section below for further details about the allowed parameters in the JDBC URL.
For further details about Liquibase usage, please check the
[official documentation](https://contribute.liquibase.com/extensions-integrations/directory/database-tutorials/cassandra/).

## Usage

Connect to a Cassandra cluster using the following arguments:
Expand Down

0 comments on commit 9ffb712

Please sign in to comment.