Contributing

First main rule is don't overthink. Anything is counted as contribution.

Filing an issue if you found a bug or request a feature / enhancement.
Providing your input / views on any existing issues.
Reviewing any opened pull requests (even if you are not an assignee).
And obviously if you want to make changes directly into the repository.

When contributing directly to this repository, please first discuss the change you wish to make via creating an issue before making a change.

Development Setup

Install Java (8 or above) and git on your system.
Fork the repository and clone it to your local system. (guide)
Run ./mvnw clean install to download all maven dependencies.

Code Changes

Implement new feature or fix bug in the code.
Write sufficient test cases to validate your new code changes.
Explain your code via adding or updating comments and javadocs.
Update the README.md with details of changes to the interface (if required).
Run ./mvnw clean install` to ensure enverthing works fine.

Pull Request

Commit your local changes to your fork repo.
Open a pull request on the main repo.
Just sit and relax. Someone will reach out to you if anything required from your side.

Code of Conduct

Please note we have a code of conduct, please follow it in all your interactions with the project.