Skip to content
Newer
Older
100644 40 lines (28 sloc) 1.69 KB
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored Sep 17, 2012
1 Contribute to Guard
2 ===================
3
4 File an issue
5 -------------
6
7 You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/guard/issues).
8
9 **Please don't ask question in the issue tracker**, instead ask them in our
10 [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
11
12 Try to figure out where the issue belongs to: Is it an issue with Guard itself or with a Guard plugin you're
13 using?
14
15 When you file a bug, please try to follow these simple rules if applicable:
16
17 * Make sure you run Guard with `bundle exec` first.
18 * Add debug information to the issue by running Guard with the `--debug` option.
19 * Add your `Guardfile` and `Gemfile` to the issue.
20 * Make sure that the issue is reproducible with your description.
21
22 **It's most likely that your bug gets resolved faster if you provide as much information as possible!**
23
24 Development
25 -----------
26
27 * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames).
28 * Source hosted at [GitHub](https://github.com/guard/guard).
29
30 Pull requests are very welcome! Please try to follow these simple rules if applicable:
31
32 * Please create a topic branch for every separate change you make.
33 * Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
34 * Update the [Yard](http://yardoc.org/) documentation.
35 * Update the [README](https://github.com/guard/guard/blob/master/README.md).
36 * Update the [CHANGELOG](https://github.com/guard/guard/blob/master/CHANGELOG.md) for noteworthy changes.
37 * Please **do not change** the version number.
38
39 For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
40 `#guard` (irc.freenode.net).
Something went wrong with that request. Please try again.