From 6b0b0460d2c7986c2f2d92d3b0ed0161af1637e8 Mon Sep 17 00:00:00 2001 From: Matt Brender Date: Tue, 24 Mar 2015 17:08:45 -0400 Subject: [PATCH] Updated README to include clear guidelines for contribution and updates to contact information --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c800636..f996ef5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 () * Author: Sean Carey () -* Author: Hector Castro () +* Author: Hector Castro ([GitHub](https://github.com/hectcastro)) * Author: Sean Cribbs () -* Author: Seth Thomas ( +* Author: Seth Thomas (cheeseplus@chef.io) Copyright (c) 2014 Basho Technologies, Inc.