CONTRIBUTING.md

Contributing to the Nitrite Database

Thank you for your interest in contributing to the Nitrite Database.

We are building this software together and strongly encourage contributions from the community that are within the guidelines set forth below.

Bug Fixes and New Features

Before starting to write code, look for existing issues or create one for your bug, issue, or feature request. This helps the community avoid working on something that might not be of interest or which has already been addressed.

Pull Requests

Pull requests should generally be made against the master (default) branch and include relevant tests, if applicable.

Code should compile and tests should pass under all Java versions that Nitrite supports. Currently, Nitrite supports a minimum version of Java 8.
Please run 'mvn test' to confirm. By default, running the tests requires

Talk To Us

If you want to work on something or have questions / complaints start a github discussion.