Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 1.83 KB
Raw

Contributing

Thank you for your interest in contributing. VoltDB uses GitHub to manage reviews of pull requests. We welcome your contributions to VoltDB or to any of the related libraries and tools.

VoltDB uses the standard github workflow, meaning we make use of forking and pull requests.

  • If you have a trivial fix or improvement, go ahead and create a pull request.

  • If you are interested in contributing something more involved, feel free to discuss your ideas in VoltDB Public on Slack.

Contributor License Agreement

In order to contribute code to VoltDB, you must first sign the VoltDB Contributor License Agreement (CLA) and email an image or PDF of the document including your hand-written signature to [email protected]. VoltDB will sign and return the final copy of the agreement for your records.

How to submit code

The workflow is essentially the following:

  1. Fork the VoltDB project
  2. Make a branch. Commit your changes to this branch. (See note below)
  3. Issue a pull request on the VoltDB repository.

Once you have signed the CLA, a VoltDB engineer will review your pull request.

Note:

It will be easier to keep your work merge-able (conflict-free) if you don't work directly on your master branch in your VoltDB fork. Rather, keep your master branch in sync with the VoltDB repository and apply your changes on a branch of your fork.

For further reading:

Additional Resources