Permalink
Browse files

Update readme, add contribution guide

  • Loading branch information...
1 parent 46f693f commit 998004f45b22216172a0ecb19da37042b979b1cf @mpraglowski mpraglowski committed Apr 26, 2016
Showing with 37 additions and 1 deletion.
  1. +27 −0 CONTRIBUTING.md
  2. +10 −1 README.md
View
@@ -0,0 +1,27 @@
+# Contributing to RubyEventStore
+
+Any kind of contribution is welcomed. Here is a few guidelines that we need contributors to follow.
+
+## Found a bug? Have a question?
+
+* [Create a new issue](https://github.com/arkency/ruby_event_store/issues/new), assuming one does not already exist.
+ * Clearly describe the issue including steps to reproduce when it is a bug.
+ * If possible provide a Pull Request with failing test case.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* [Fork the repository](https://help.github.com/articles/fork-a-repo/) on GitHub.
+
+## Making Changes
+
+* Create a feature branch from where you want to base your work.
+* Do your work. Please try to keep your commits small and focussed.
+* Make sure you have added the necessary tests for your changes.
+* Push your changes to a feature branch in your fork of the repository.
+* Submit a pull request to the RubyEventStore repository.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
View
@@ -2,10 +2,19 @@
[![Gem Version](https://badge.fury.io/rb/ruby_event_store.svg)](http://badge.fury.io/rb/ruby_event_store)
[![Code Climate](https://codeclimate.com/github/arkency/ruby_event_store/badges/gpa.svg)](https://codeclimate.com/github/arkency/ruby_event_store)
[![Test Coverage](https://codeclimate.com/github/arkency/ruby_event_store/badges/coverage.svg)](https://codeclimate.com/github/arkency/ruby_event_store/coverage)
+[![Join the chat at https://gitter.im/arkency/rails_event_store](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/arkency/rails_event_store?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# RubyEventStore
-A Ruby implementation of an EventStore. It is an integral part of `rails_event_store` gem.
+A Ruby implementation of an EventStore. It is an integral part of [rails_event_store](http://github.com/arkency/rails_event_store) gem.
+
+# Documentation
+
+All documentation and sample codes are available at [http://railseventstore.arkency.com](http://railseventstore.arkency.com)
+
+# Contributing
+
+Check the contribution guide on [CONTRIBUTING.md](https://github.com/arkency/ruby_event_store/blob/master/CONTRIBUTING.md)
## About

0 comments on commit 998004f

Please sign in to comment.