How to contribute

If you want to contribute to Omid, please read this page. Here we detail what are our requirements to accept a pull request and what you could work on if interested.

Patch Guidelines

• Lines must be shorter than 120 characters
  • Where it makes sense a line could surpass this limit, but only with a good reason
• Use general good practices:
  • Short, descriptive names for variables, functions and classes
  • Documentation comments for methods and classes
  • Succinct comments
  • Encapsulate as much as possible
• Small, incremental changes accompanied by unit tests.
• Consisten indentation with the rest of the project (4 spaces)

What to work on

A general list of items to work on is here. Feel free to come up with you own ideas and discuss them with us on [email protected]

• Testing
• Integration with other KeyValue stores (Cassandra, Memcached, ...)
• Benchmarks against other transactional KV stores (VoltDB...)