Browse files

Add contributing guidelines. [ci skip]

  • Loading branch information...
1 parent 76a849c commit 94623f22ddc05e6ba39515f5dd19fde28c2d3f23 @netzpirat netzpirat committed Sep 17, 2012
Showing with 40 additions and 0 deletions.
  1. +40 −0
@@ -0,0 +1,40 @@
+Contribute to Guard
+File an issue
+You can report bugs and feature requests to [GitHub Issues](
+**Please don't ask question in the issue tracker**, instead ask them in our
+[Google group]( or on `#guard` (
+Try to figure out where the issue belongs to: Is it an issue with Guard itself or with a Guard plugin you're
+When you file a bug, please try to follow these simple rules if applicable:
+* 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!**
+* Documentation hosted at [RubyDoc](
+* Source hosted at [GitHub](
+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 [Yard]( documentation.
+* Update the [README](
+* Update the [CHANGELOG]( for noteworthy changes.
+* Please **do not change** the version number.
+For questions please join us in our [Google group]( or on
+`#guard` (

1 comment on commit 94623f2


slurp :)

Please sign in to comment.