|
2 | 2 |
|
3 | 3 |  |
4 | 4 |
|
5 | | -Riak Core is the distributed systems framework that forms the basis of |
6 | | -how [Riak](https://github.com/OpenRiak/riak) distributes data and scales. |
7 | | -More generally, it can be thought of as a toolkit for building |
8 | | -distributed, scalable, fault-tolerant applications. |
| 5 | +Riak Core is the distributed systems framework that forms the basis of how [Riak](https://github.com/OpenRiak/riak) distributes data and scales. |
| 6 | +More generally, it can be thought of as a toolkit for building distributed, scalable, fault-tolerant applications. |
9 | 7 |
|
10 | | -For some introductory reading on Riak Core (that’s not pure code), |
11 | | -there’s an old but still valuable |
12 | | -[blog post on the Basho Blog](http://basho.com/where-to-start-with-riak-core/) |
13 | | -that’s well worth your time. |
| 8 | +For some introductory reading on Riak Core (that’s not pure code), there’s an old but still valuable [blog post on the Basho Blog](http://basho.com/where-to-start-with-riak-core/) that’s well worth your time. |
14 | 9 |
|
15 | | -This repository retains the history of the original [Basho repository](https://github.com/basho/riak_core/), |
16 | | -but is no longer forked from it as the OpenRiak version evolves. |
| 10 | +This repository retains the history of the original [Basho repository](https://github.com/basho/riak_core/), but is no longer forked from it as the OpenRiak version evolves. |
17 | 11 |
|
18 | 12 | The prior OpenRiak [fork](https://github.com/OpenRiak/riak_core-forked) is retained for historical purposes. |
19 | 13 |
|
| 14 | +The [riak_core_lite](https://riak-core-lite.github.io/) project also provides a modernised alternative to Riak Core targeted at those intending to build non-Riak applications on a riak_core-like platform. |
| 15 | + |
| 16 | +## OTP version support |
| 17 | + |
| 18 | +Riak is built on top of the [Erlang/OTP platform](https://github.com/erlang/otp). Supported versions for this release are: |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +For later OTP versions, an alternative `openriak-<release>` branch will be required e.g. [`openriak-3.4` for OTP 26](https://github.com/OpenRiak/riak_core/tree/openriak-3.4). See [the roadmap discussion](https://github.com/orgs/OpenRiak/discussions/19) for further details. |
| 23 | + |
20 | 24 | ## Contributing |
21 | 25 |
|
22 | 26 | We love community code, bug fixes, and other forms of contribution. We |
23 | 27 | use GitHub Issues and Pull Requests for contributions to this and all |
24 | 28 | other code. To get started: |
25 | 29 |
|
26 | 30 | 1. Fork this repository. |
27 | | -2. Clone your fork or add the remote if you already have a clone of |
28 | | - the repository. |
| 31 | +2. Clone your fork or add the remote if you already have a clone of the repository. |
29 | 32 | 3. Create a topic branch for your change. |
30 | | -4. Make your change and commit. Use a clear and descriptive commit |
31 | | - message, spanning multiple lines if detailed explanation is needed. |
| 33 | +4. Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed. |
32 | 34 | 5. Push to your fork of the repository and then send a pull request. |
33 | | -6. An OpenRiak maintainer will review your patch and merge it into the main |
34 | | - repository or send you feedback. |
| 35 | +6. An OpenRiak maintainer will review your patch and merge it into the main repository or send you feedback. |
35 | 36 |
|
36 | 37 | ## Issues, Questions, and Bugs |
37 | 38 |
|
38 | 39 | There are numerous ways to file issues or start conversations around |
39 | 40 | something Core related. |
40 | 41 |
|
41 | | -* The [Riak Slack](https://postriak.slack.com) community is often the quickest place to get answers to Riak and Core questions. |
42 | | -* Riak Core development initiatives are located in this repo's [discussions](https://github.com/OpenRiak/riak_core/discussions) section. |
43 | | -* Known issues are discussed in this repo's [issues](https://github.com/OpenRiak/riak_core/issues) section. |
44 | | -* If you've found a bug in Riak Core, please [file](https://github.com/OpenRiak/riak_core/issues) a clear, concise, explanatory issue against this repo. |
| 42 | +- There is an `open-riak` group on the [Slack channel for the Erlang Ecosystem Foundation](https://erlef.org/slack-invite/erlef), where ad-hoc discussions on riak development take place. |
| 43 | +- The [Riak Slack](https://postriak.slack.com) is also available for Riak and Core questions. |
| 44 | +- Riak Core development initiatives are located in this repo's [discussions](https://github.com/OpenRiak/riak_core/discussions) section, or [the organisation discussion board](https://github.com/orgs/OpenRiak/discussions). |
| 45 | +- Known issues are discussed in this repo's [issues](https://github.com/OpenRiak/riak_core/issues) section. |
| 46 | +- If you've found a bug in Riak Core, please [file](https://github.com/OpenRiak/riak_core/issues) a clear, concise, explanatory issue against this repo. |
0 commit comments