Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.13 KB

Java CI - deploy License

How to contribute to ArcadeDB

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability, and instead write to support -at- arcadedb.com.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one . Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an ** executable test case** demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in the ArcadeDB Community and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Prepare your environment

Pre-commit

This project uses pre-commit. Every developer should install it locally, please follow installation instructions for your operative system.

Developer guide

Getting the code using a Git client using SSH:

$ git clone [email protected]:ArcadeData/arcadedb.git

Build the project using Maven:

$ cd arcadedb
$ mvn clean verify