Contribute to CrateDB

We are an open source company by heart, and we welcome contributions from our community. This does not only mean code, but also engaging on Stack Overflow, user groups, documentation, submitting bugs and issues and of course feature requests.

Request Features & Report Issues

We are aware that many features have to be added over time. In order to help prioritize we also want to get your feedback. Just open an issue on Github and describe the feature you want and how it should work. If you explain why you’re making the feature request, we may find a way to help you.

Before reporting an issue, make sure you use the latest version of CrateDB and search our issues list on Github, it may be already tracked and in the pipeline. If possible help us in reproducing the bug by delivering a small test case so we can run a test against it.

Contribute Code

We appreciate your ideas and help. Before you start to contribute please contact us, just to make sure nobody else is already working on that problem or feature. In order to optimize the way things get solved it is best to discuss your approach with us before writing too much code – we want your code to get accepted!

  1. Fork and clone the repository
    Clone the main Crate repository to your local machine.
  2. Start coding
    The document DEVELOP.rst on GitHub has detailled instructions about how to work on Crate.
  3. Test your changes
    Run tests to make sure that nothing is broken.
  4. Sign the Contributor License Agreement (CLA)
    We are not asking you to give us your copyright, but we need to get your OK to distribute your code without restriction.
  5. Update your local repository with latest Crate code
    Rebase your branch on top of the latest master branch. We prefer your changes to be squashed into a single commit.
  6. Submit a pull request
    Update your forked copy of the repository and submit a pull request to our team. Please describe your changes, and if possible refer to the issues solved on the issue list.
  7. Grab a coffee
    Our team will review the pull request and discuss it internally. We may come back to you. And if things go well pull your request into the code base.