Skip to content

Commit

Permalink
Updated README to include clear guidelines for contribution and updat…
Browse files Browse the repository at this point in the history
…es to contact information
  • Loading branch information
mbbroberg committed Mar 24, 2015
1 parent 01f0c93 commit 6b0b046
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@

## Description

[Riak](http://basho.com/riak/) is an open source, distributed database that
focuses on high availability, horizontal scalability, and *predictable*
latency.
[Riak](http://basho.com/riak/) is an open source, distributed database that focuses on high availability, horizontal scalability, and *predictable* latency.

This repository is **community supported**. We both appreciate and need your contribution to keep it stable. For more on how to contribute, [take a look at the contribution process](#contribution).

Thank you for being part of the community! We love you for it.

## Requirements

Expand Down Expand Up @@ -272,13 +274,33 @@ Basho's) and want to install Riak from there, ensure that
If you want to install Riak (and Erlang) from source, ensure that
`node['riak']['install_method']` is set to `source`.

##Contributions

Basho Labs repos survive because of community contribution. Here’s how to get started.

* Fork the appropriate sub-projects that are affected by your change
* Create a topic branch for your change and checkout that branch
`git checkout -b some-topic-branch`
* Make your changes and run the test suite if one is provided (see below)
* Commit your changes and push them to your fork
* Open a pull request for the appropriate project
* Contributors will review your pull request, suggest changes, and merge it when it’s ready and/or offer feedback
* To report a bug or issue, please open a new issue against this repository

### Maintainers
* Seth Thomas ([GitHub](https://github.com/cheeseplus))
* and You! [Read up](https://github.com/basho-labs/the-riak-community/blob/master/config-mgmt-strategy.md) and get involved

You can [read the full guidelines](http://docs.basho.com/riak/latest/community/bugs/) for bug reporting and code contributions on the Riak Docs. And **thank you!** Your contribution is incredible important to us.


## License and Authors

* Author: Benjamin Black (<[email protected]>)
* Author: Sean Carey (<[email protected]>)
* Author: Hector Castro (<hector@basho.com>)
* Author: Hector Castro ([GitHub](https://github.com/hectcastro))
* Author: Sean Cribbs (<[email protected]>)
* Author: Seth Thomas (<[email protected]>
* Author: Seth Thomas ([email protected])

Copyright (c) 2014 Basho Technologies, Inc.

Expand Down

0 comments on commit 6b0b046

Please sign in to comment.