Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 2.7 KB
Raw

Contributing to Deeplearning4j

Thanks for your interest in DL4J. Our goal is to bring fast, open-source deep learning to all JVM-based communities.

Getting Started

Deeplearning4j's open issues are here. In time, we'll tag issues that would make a good first pull request for new contributors. An easy way to get started helping the project is to file an issue. You can do that on the Deeplearning4j issues page by clicking on the green button at the right. Issues can include bugs to fix, features to add, or documentation that looks outdated.

Note that you will need to build dl4j from source

For some tips on contributing to open source, this post is helpful.

Contributions

Deeplearning4j welcomes contributions from everyone.

Contributions to Deeplearning4j should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.

Pull Request Checklist

  • Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • Don't put submodule updates in your pull request unless they are to landed commits.

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.

  • Work-in-progress pull requests are welcome. Please prefix them with [WIP] to tell the continuous integration (CI) backend not to run tests/checks on them (until that tag is removed and another commit is pushed up).

  • Add tests relevant to the fixed bug or new feature.

Conduct & License

We follow the Rust Code of Conduct.

All code in this repository is released under the Apache Software Foundation License, 2.0, and by contributing to this repository, you agree to release that contribution under that same license.

Eclipse Contributor Agreement and Commit Signing

Please see the following page for details: https://deeplearning4j.konduit.ai/multi-project/how-to-guides/contribute/eclipse-contributors