Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add CONTRIBUTING.md [ci skip] #152

Merged
merged 2 commits into from
Oct 27, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
`Guard::LiveReload` is a volunteer effort, so the easier it is to reproduce your problem, the faster it may get solved.

Please try to provide enough info to reproduce a problem, including:

1. Running `bundle exec guard -d` to show full debugging output.

2. Any console output your browser shows.

3. Mentioning what you're doing and how (local/remote livereload, which browser, which OS, which extension, with `Rack`, `Rails`, `Jekyll` or whatever, etc.).

3. Ideally, providing a small repository, so we can reproduce the issue ourselves.

4. Going through our [Troubleshooting](https://github.com/guard/guard-livereload/wiki/Troubleshooting) guide to see if there's a quick fix for your problem already.

5. It's better to create a new issue (with full info above) than to add to an existing issue (unless you're absolutely sure it's exactly the same issue). It's better to link issues to each other instead.

That's it!