### CONTRIBUTING

# 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 spotless:apply 
    ```

## Produce Community Distribution

To produce the community distribution just run  

```bash
mvn clean install
```  

this command will produce two files `distribution/target/orientdb-community-(version).tar.gz` `distribution/target/orientdb-community-(version).zip`

## Opening a issue

If you have problem you can just open a issue on [Github Issue Tracker](github.com/orientechnologies/orientdb/issues) following the issue template.

## Send a Pull Request

You can send a pull request for fixes or for features to the [Github Pull Requests](https://github.com/orientechnologies/orientdb/pulls) to be accepted the 
PR should respect the PR template, and provide test cases for the issue fixed or new features, and should not include regressions on existing tests.

---

### README

## OrientDB

[](https://opensource.org/licenses/Apache-2.0)
[](https://api.reuse.software/info/github.com/orientechnologies/orientdb)

------

## What is OrientDB?

**OrientDB** is an Open Source Multi-Model [NoSQL](http://en.wikipedia.org/wiki/NoSQL) DBMS with the support of Native Graphs, Documents, 
Full-Text search, Reactivity, Geo-Spatial and Object Oriented concepts. It's written in Java and it's amazingly fast. 
No expensive run-time JOINs, connections are managed as persistent pointers between records. 
You can traverse thousands of records in no time. Supports schema-less, schema-full and schema-mixed modes. 
Has a strong security profiling system based on user, roles and predicate security and supports [SQL](https://orientdb.org/docs/3.1.x/sql/) amongst the query languages. 
Thanks to the [SQL](https://orientdb.org/docs/3.1.x/sql/) layer it's straightforward to use for people skilled in the Relational world.

[Get started with OrientDB](http://orientdb.org/docs/3.2.x/gettingstarted/) | 
[OrientDB Community Group](https://github.com/orientechnologies/orientdb/discussions) | 
[Dev Updates](https://fosstodon.org/@orientdb) | 
[Community Chat](https://matrix.to/#/#orientdb-community:matrix.org) .

## Is OrientDB a Relational DBMS?

No. OrientDB adheres to the [NoSQL](http://en.wikipedia.org/wiki/NoSQL) movement even though it supports [ACID Transactions](https://orientdb.org/docs/3.2.x/internals/Transactions.html) and 
[SQL](https://orientdb.org/docs/3.2.x/sql/) as query language. In this way it's easy to start using it without having to learn too much new stuff. 


## Easy to install and use

Yes. OrientDB is totally written in [Java](http://en.wikipedia.org/wiki/Java_%28programming_language%29) and can run on any platform without configuration and installation. 
Do you develop with a language different than Java? No problem, look at the [Programming Language Binding](http://orientdb.org/docs/3.1.x/apis-and-drivers/).


## Main References
- [Documentation Version < 3.2.x](http://orientdb.org/docs/3.1.x/)
- For any questions visit the [OrientDB Community Group](https://github.com/orientechnologies/orientdb/discussions)

[Get started with OrientDB](http://orientdb.org/docs/3.2.x/gettingstarted/).

--------
## Contributing

For the guide to contributing to OrientDB checkout the [CONTRIBUTING.MD](https://github.com/orientechnologies/orientdb/blob/develop/CONTRIBUTING.md)

All the contribution are considered licensed under Apache-2 license if not stated otherwise.

--------

## Licensing
OrientDB is licensed by OrientDB LTD under the Apache 2 license. OrientDB relies on the following 3rd party libraries, which are compatible with the Apache license:

- Javamail: CDDL license (http://www.oracle.com/technetwork/java/faq-135477.html)
- java persistence 2.0: CDDL license
- JNA: Apache 2 (https://github.com/twall/jna/blob/master/LICENSE)
- Hibernate JPA 2.0 API: Eclipse Distribution License 1.0
- ASM: OW2

References:
- Apache 2 license (Apache2):
  http://www.apache.org/licenses/LICENSE-2.0.html

- Common Development and Distribution License (CDDL-1.0):
  http://opensource.org/licenses/CDDL-1.0

- Eclipse Distribution License (EDL-1.0):
  http://www.eclipse.org/org/documents/edl-v10.php (http://www.eclipse.org/org/documents/edl-v10.php)
  
### Sponsors

[](http://www.softpedia.com/get/Internet/Servers/Database-Utils/OrientDB.shtml#status)

--------


### Reference

Recent architecture re-factoring and improvements are described in our [BICOD 2021](http://ceur-ws.org/Vol-3163/BICOD21_paper_3.pdf) paper:

```
@inproceedings{DBLP:conf/bncod/0001DLT21,
  author    = {Daniel Ritter and
               Luigi Dell'Aquila and
               Andrii Lomakin and
               Emanuele Tagliaferri},
  title     = {OrientDB: {A} NoSQL, Open Source {MMDMS}},
  booktitle = {Proceedings of the The British International Conference on Databases
               2021, London, United Kingdom, March 28, 2022},
  series    = {{CEUR} Workshop Proceedings},
  volume    = {3163},
  pages     = {10--19},
  publisher = {CEUR-WS.org},
  year      = {2021}
}
```

---