Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 54 lines (39 sloc) 3.09 kB
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
1 Contribute to Guard
2 ===================
3
4 File an issue
5 -------------
6
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
7 Please check guard's [GitHub issue tracker](https://github.com/guard/guard/issues) for known issues. Additionally you should check [listen's issue tracker](https://github.com/guard/listen/issues) for issues which affect guard's behaviour; for example, there is currently a nasty [bug preventing listen from watching files inside symlinked directories](https://github.com/guard/listen/issues/25).
8
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
9 You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/guard/issues).
10
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
11 **Please don't ask question in the issue tracker**, instead ask them at one of our other places:
12
13 * Use the guard tag at [StackOverflow](http://stackoverflow.com/questions/tagged/guard).
14 * [Google+ community](https://plus.google.com/u/1/communities/110022199336250745477)
15 * [Google group](http://groups.google.com/group/guard-dev)
16 * IRC channel `#guard` (irc.freenode.net) for chatting
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
17
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
18 Try to figure out where the issue belongs to: is it an issue with Guard itself or with a Guard plugin you're using (e.g. guard-rspec, guard-cucumber, etc.)?
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
19
20 When you file a bug, please try to follow these simple rules if applicable:
21
b6e8657 @netzpirat Update CONTRIBUTING guidelines. [ci skip]
netzpirat authored
22 * Make sure you've read the README carefully.
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
23 * Make sure you run Guard with `bundle exec` first.
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
24 * Add debug information to the issue by running Guard with the `--debug` option
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
25 * Add your `Guardfile` and `Gemfile` to the issue.
9041bce @netzpirat Update contributing guidelines.
netzpirat authored
26 * Provide information about your environment:
27 * Your current versions of your OS, Ruby, Rubygems and Bundler.
28 * Shared project folder with services like Dropbox, NFS, etc.
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
29 * Make sure that the issue is reproducible with your description.
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
30 * If Guard is not responding to file changes and/or is not firing rules correctly:
31 * see [listen](http://github.com/guard/listen) for more info on troubleshooting.
32 * run guard with the `LISTEN_GEM_DEBUGGING` environment variable set to 1 (info) or 2 (debug) which shows what's happening under the hood and how fast)
33 * If you are using plugins, check out their respective README files (disabling spring, adding bundle to plugin's command, special debug options, etc.)
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
34
35 **It's most likely that your bug gets resolved faster if you provide as much information as possible!**
36
37 Development
38 -----------
39
40 * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames).
41 * Source hosted at [GitHub](https://github.com/guard/guard).
42
43 Pull requests are very welcome! Please try to follow these simple rules if applicable:
44
45 * Please create a topic branch for every separate change you make.
6ff4a4f @e2 remove duplicated sections in docs
e2 authored
46 * TIP: run `rubocop` locally before pushing (so your PR won't trigger HoundCI comments)
d9c30f4 @rymai Improve the contributing guide
rymai authored
47 * Make sure your patches are well tested. All specs must pass when run on [Travis CI](https://travis-ci.org/guard/guard).
94623f2 @netzpirat Add contributing guidelines. [ci skip]
netzpirat authored
48 * Update the [Yard](http://yardoc.org/) documentation.
49 * Update the [README](https://github.com/guard/guard/blob/master/README.md).
50 * Please **do not change** the version number.
51
52 For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
b6e8657 @netzpirat Update CONTRIBUTING guidelines. [ci skip]
netzpirat authored
53 `#guard` (irc.freenode.net).
Something went wrong with that request. Please try again.