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

Latest commit

 

History

History
17 lines (9 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

17 lines (9 loc) · 1.35 KB

How to contribute

We like pull requests. For small changes, fork our repository and make the pull request. For larger changes, please open an issue so that we can discuss your proposed changes. If you're not familiar with pull requests, Github has some good documentation on this.

Unit Tests

Please run the unit tests before making a pull request: mvn test. If you are adding new functionality, include unit tests with your pull request.

Coding Style Guidelines

We follow the Google Java Style with the exception of using 4 spaces instead of 2 for indentation. We additionally use the Jode javadoc style for javadoc. Pull requests are checked for Google style compliance using Travis CI. You can also run the check manually with mvn checkstyle:check.

If you are developing with Eclipse, we include code style files in the .developers directory.

Contributor License Agreement

You need to sign the Contributor License Agreement before we can accept any pull requests from you. You will receive a reminder on your pull request if you have not signed it.