From da81c746d5afd764d7555d3d9f01d7330a93d9d6 Mon Sep 17 00:00:00 2001 From: Tglman Date: Mon, 10 Jul 2023 15:54:09 +0100 Subject: [PATCH] chore: add contributing document --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..caffa7fd620 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing + + +## Getting the source + +- Check out source code: + ```bash + git clone https://github.com/orientechnologies/orientdb.git orientdb + ``` + +## Prerequisites + +A Java JDK version 8 or later is needed. +Maven 3.5 or later is needed. + +## Build + +- Only compile + + ```bash + mvn clean compile + ``` +- Run base tests + + ```bash + mvn clean test + ``` +- Full build + + ```bash + mvn clean install + ``` +- Run integration tests (hours long tests) + + ```bash + mvn clean install failsafe:integration-test + ``` +- Format the code with standard format used by OrientDB + + ```bash + mvn com.coveo:fmt-maven-plugin:format + ``` + +## Produce Community Distribution + +To produce the community distribution just run + +```bash +mvn clean install +``` + +this will produce two files `distribution/target/orientdb-community-(version).tar.gz` `distribution/target/orientdb-community-(version).zip`