H2O is an open source project released under the Apache Software Licence v2. Open Source projects live by their user and developer communities. We welcome and encourage your contributions of any kind!
There are many different kinds of people who make use of H2O for their daily work:
- Data Scientists who use R, Python, Scala, Java or the Flow web interface;
- Application Software Developers who build software to drive H2O from those languages or the REST API;
- Machine Learning and data munging developers, who want to extend the internal capabilities of H2O.
No matter what your skill set or level of engagement is with H2O you can help others by improving the ecosystem of documentation, bug report and feature request tickets, and code.
The single most important contribution that you can make is to report bugs and make feature requests. The development work on H2O is largely driven by these, so please make your voice heard!
Bug reports are most helpful if you send us a script which reproduces the problem.
If you're a customer with an Enterprise Support contract you should send these to [email protected].
If you're an Open Source community member you should send these to one of:
- The h2ostream mailing list, at: https://groups.google.com/forum/#!forum/h2ostream
- Gitter chat, at https://gitter.im/h2oai/h2o-3
All bugs and feature requests get added to the JIRA tracking system at https://0xdata.atlassian.net/projects/PUBDEV, where you can track their progress.
Note: JIRA issues for customers with Enterprise Support contracts go into a private project so that customer information is kept secure. Contact [email protected] for more information.
You can also vote for bugs and feature requests that are added to JIRA. To vote for a JIRA issue, log in the the H2O JIRA tracking system (create an account if necessary), find or create the issue that you want to vote for, then click the Vote for this issue link (upper right portion of the issue). Voting can help H2O prioritize the features that are included in each release.
You can help others directly and help improve the resources that others read to learn and use H2O by contributing to the formal documentation or the forums.
There are several places that users find information about using H2O:
- Formal documentation, at: http://docs.h2o.ai/
- The h2ostream mailing list, at: https://groups.google.com/forum/#!forum/h2ostream
- Gitter chat, at https://gitter.im/h2oai/h2o-3
- General community sites like Stack Overflow: http://stackoverflow.com/search?q=h2o
- Individuals' blogs
All of the documentation comes directly from the source tree in GitHub. To contribute improvements to the formal documentation you may either:
- send the suggestions or changes to [email protected], h2ostream or Gitter, or
- use Git to make the changes yourself and submit them via a pull request (see below for details)
Answering questions for other users on h2ostream, Gitter, Stack Overflow and other forums builds the community knowledge base and is a very valuable contribution to H2O.
Some of the most interesting written materials on the use of H2O for real world problems has been published by community members to their personal blogs. If you've written something about H2O that you think should be more widely known contact us on h2ostream or Gitter and we will help you get the word out.
The H2O code base contains tests and demos written in R, Python, Java, Scala and Flow. These get run as part of every build of the software, either by gradlew build on the development machine, or by Jenkins. Standalone demos are conformed into xUnit tests as part of the build process. All tests must succeed before we release a stable build.
If you are able to you should clone the H2O git repository, add your test case(s) there, and submit a pull request (see below). If not, please send your code to h2ostream, Gitter or [email protected]; see above for the links.
Test directories include:
- user-level tests in R:
h2o-r/tests/ - user-level tests in Python:
h2o-py/tests/ - REST API tests in Python:
py/testdir_multi_jvm/ - platform tests in Java:
h2o-core/src/test/java/ - algorithm tests in Java:
h2o-algos/src/test/java/ - Flow tests in saved notebooks:
h2o-docs/src/product/flow/packs
For Scala tests see the Sparkling Water GitHub repo.
You can contribute R, Python, Java or Scala code for H2O, either for bug fixes or new features. If you have your own idea about what to work on a good place to begin is to discuss it with us on Gitter so that we can help point you in the right direction.
For ideas about what to work on see our JIRA ticket system.
Clone the H2O-3 GitHub repo, create a branch for your work, and after you're done make sure all the tests pass. New code must come with tests.
Once you are done submit a pull request through GitHub.