Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.22 KB
Raw

Contributing to Spring Data ArangoDB

Build

The project is built using Maven with JDK 17.

mvn clean compile

Test

Tests are written using JUnit 5 and Hamcrest and run using mvn test.

To run tests integrated with a database server, the easiest way is to use docker to spin up a single server:

./docker/start_db.sh

More server versions and starter modes will be checked for a pull request.

Contribute

To contribute code:

  1. create a fork of this repository
  2. create a branch on the fork
  3. commit and push your changes to your branch
  4. make sure the tests run on your local machine
  5. create a pull request from your branch to main of this repository
  6. make sure all checks are green for your pull request (only with CLA signed)

Do not change the project version, this will be done after merge on main.

To accept external contributions, we need you to fill out and sign our CLA. We use an Apache 2 CLA for ArangoDB. You can scan and email the CLA PDF file to [email protected] or send it via fax to +49-221-2722999-88.