Skip to content
This repository has been archived by the owner on Dec 19, 2022. It is now read-only.

Latest commit

 

History

History
21 lines (15 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1.08 KB

First of all, thank you for taking the time to contribute!!

Guidelines

Code quality

We put our best effort into providing high quality software that is readable (class, field, and method names are written in English as much as possible), well documented, and well tested. We would greatly appreciate if your contribution goes the same way.

Code formatting

We use a custom Java formatting that can be found here. It can be easily integrated to different IDEs such as Eclipse and IntelliJ. Any contribution we'll be formatted before being accepted.

How can I contribute

JavaDoc

You can report to us any misleading, incomplete documentation or any typos you find. This is the easiest way to contribute, but it is still an important contribution that we would greatly appreciate.

Bug report

If you find a bug, it will greatly help us if you could provide a failing JUnit test with the bug report or at least a concrete example so it is easy for us to reproduce the bug on our side.