Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.98 KB
Raw

Contribute

Flavours

Since there are different flavours of ecAudit for different Cassandra versions, new patch sets should be created on the oldest maintained release branch. Once incorporated on the release branch the patch set will be merged forward on to more resent release branches (if any) and then finally into the master branch.

This way feature compatibility will be maintained on the different flavours of ecAudit.

At the moment the oldest maintained release branch is release/c3.0 which is tracking the latest release of Cassandra 3.0.x. The master branch is tracking the latest release of Cassandra 3.11.x.

Code Style

Code style settings are included in the repository for Intellij IDEA. They should be picked up automatically when you import the Maven project at the root of the repository. The intention is to use the same settings as those of Apache Cassandra.

Build & Test

If you're looking to contribute to ecAudit you should sign up on Travis and Coveralls, and enable builds and reports on your own fork of ecAudit. This allow you to verify your patch before you create a pull request.

You can also execute Mutation Tests on your local machine based on the Pitest framework. To run them, execute:

mvn clean compile test org.pitest:pitest-maven:mutationCoverage

The report will be available in the target/pit-reports/ directory.

CCM

If you have CCM installed on your workstation you can easily verify parts of ecAudit in a local test cluster. Prepare by building the ecAudit project with maven and initialize a ccm cluster using a matching Cassandra version.

To install ecAudit into the ccm cluster, execute:

./bin/install_into_current_ccm.sh

Now you can operate your ccm cluster as always and try out ecAudit. Remember to provide the standard credentials when you login:

ccm node1 cqlsh -u cassandra -p cassandra