Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (19 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.04 KB

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Setup

  1. Install Java 8 and Maven 3
  2. Install IntelliJ IDEA 2017.1+ on your system (Community Edition should be fine): https://www.jetbrains.com/idea/download/
  3. Fork the repo: https://github.com/AquaticInformatics/aquarius-sdk-java

Building

Either build from within IntelliJ, or run mvn package from the root of the repo.

Testing

The JUnit-based test suite can be run from with IntelliJ, or run mvn test from the root of the repo.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.

License

By contributing to the Aquarius SDK, you agree that your contributions will be licensed under its AGPLv3 license.