Permalink
Browse files

Create CONTRIBUTING.md

  • Loading branch information...
1 parent b914bcf commit e1f6ad03b3dadf1a6014fdd5d56b2d19bcd9160d @rymai rymai committed Jan 22, 2013
Showing with 38 additions and 0 deletions.
  1. +38 −0 CONTRIBUTING.md
View
@@ -0,0 +1,38 @@
+Contribute to Guard::RSpec
+==========================
+
+File an issue
+-------------
+
+You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/guard-rspec/issues).
+
+**Please don't ask question in the issue tracker**, instead ask them on at Stack Overflow and use the
+[guard](http://stackoverflow.com/questions/tagged/guard) tag and/or [guard-rspec](http://stackoverflow.com/questions/tagged/guard-rspec).
+
+Try to figure out where the issue belongs to: Is it an issue with Guard::RSpec itself or with Guard?
+
+When you file a bug, please try to follow these simple rules if applicable:
+
+* Make sure you've read the README carefully.
+* Make sure you run Guard with `bundle exec` first.
+* Add debug information to the issue by running Guard with the `--debug` option.
+* Add your `Guardfile` and `Gemfile` to the issue.
+* Make sure that the issue is reproducible with your description.
+
+**It's most likely that your bug gets resolved faster if you provide as much information as possible!**
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-rspec/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard-rspec).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
+* Update the [README](https://github.com/guard/guard-rspec/blob/master/README.md).
+* Please **do not change** the version number.
+
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).

0 comments on commit e1f6ad0

Please sign in to comment.