Skip to content

Latest commit

 

History

History
36 lines (33 loc) · 1.66 KB

README.org

File metadata and controls

36 lines (33 loc) · 1.66 KB
Raw

riak_core

Overview

Riak Core is an open source Erlang library that helps you build distributed, scalable, fault-tolerant applications. Riak Core is influenced by the Amazon Dynamo Paper and CAP Theorem.

Quick Start

You must have Erlang/OTP R13B04 or later and a GNU-style build system to compile and run riak_core. The easiest way to utilize riak_core is by installing the full Riak application available on Github. You can also view the Riak Core EDocs here.

Contributing

We encourage contributions to riak_core from the community.

  1. Fork the riak_core repository on Github.
  2. Clone your fork or add the remote if you already have a clone of the repository.
git clone git@github.com:yourusername/riak_core.git
# or
git remote add mine git@github.com:yourusername/riak_core.git
  1. Create a topic branch for your change.
git checkout -b some-topic-branch
  1. Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed.
  2. Push to your fork of the repository and then send a pull-request through Github.
git push mine some-topic-branch
  1. A Basho engineer or community maintainer will review your patch and merge it into the main repository or send you feedback.