From 273a3db44037b7b20976ea636e9f47b6cff46226 Mon Sep 17 00:00:00 2001 From: Cezary Baginski Date: Tue, 27 Oct 2015 00:59:44 +0100 Subject: [PATCH 1/2] add CONTRIBUTING.md [ci skip] --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39cacd0 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. Including any console output in 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. Go through the https://github.com/guard/guard-livereload/wiki/Troubleshooting wiki 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 sure it's exactly the same issue). It's better to link issues to each other instead. + +That's it! From 2eddb01dfe1014b18782f45fe52db60a04633a34 Mon Sep 17 00:00:00 2001 From: jibiel Date: Tue, 27 Oct 2015 03:12:45 +0300 Subject: [PATCH 2/2] Slightly improve wording of and add punctuation to `CONTRIBUTING.md`. --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39cacd0..5cdfac8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ -Guard::LiveReload is a volunteer effort, so the easier it is to reproduce your problem, the faster it may get solved. +`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 +1. Running `bundle exec guard -d` to show full debugging output. -2. Including any console output in your browser shows +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. 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 +3. Ideally, providing a small repository, so we can reproduce the issue ourselves. -4. Go through the https://github.com/guard/guard-livereload/wiki/Troubleshooting wiki to see if there's a quick fix for your problem already +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 sure it's exactly the same issue). It's better to link issues to each other instead. +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!