CONTRIBUTING.md

Contribution Guidelines

First of all, thanks for thinking of contributing to this project. 😄

• Before sending a Pull Request, please make sure that you have had a discussion with the project admins.

  • If a relevant issue already exists, discuss on the issue and make sure that the admins are okay with your approach
  • If no relevant issue exists, open a new issue and discuss

  Please proceed with a Pull Request only after the project admins or owners are okay with your approach. It'd be sad if your Pull Request (and your hard work) isn't accepted just because it isn't ideologically compatible.

• Install the required dependencies.

  • Install Git so that you can clone and later submit a PR for this project.
  • Install Java JDK (>= 1.8.0_112) installed, from this link.
  • Install Eclipse from this link.
  • (optional) Install Maven from this link, if you need to build the project from the command-line.

• Have some issue with setting up the project?

  • How to open the project in Eclipse as a Maven project?
  • Maven is not able to install the dependencies behind proxy!
  • Not listed here? Kindly search on Google / Stack Overflow. If you don't find a solution, feel free to open up a new issue in the issue tracker and maybe subsequently add it here.

• Send in your Pull Request(s) to the develop branch of this repository.