Added contributing guide [skip ci]

Andrew
1 parent 15499349
Showing 1 changed file with 51 additions and 0 deletions Show diff stats
CONTRIBUTING.md
@@ -0,0 +1,51 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Questions
+
+Use [Stack Overflow](https://stackoverflow.com/) with the tag `searchkick`.
+
+## Feature Requests
+
+Create an issue. Start the title with `[Idea]`.
+
+## Issues
+
+Think you’ve discovered an issue?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "searchkick", github: "ankane/searchkick"
+```
+
+3. Try the `debug` option when searching. This can reveal useful info.
+
+```ruby
+Product.search("something", debug: true)
+```
+
+If the above steps don’t help, create an issue.
+
+- For incorrect search results, recreate the problem by forking [this gist](https://gist.github.com/ankane/f80b0923d9ae2c077f41997f7b704e5c). Include a link to your gist and the output in the issue.
+- For exceptions, include the complete backtrace.
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+- Add one or more tests if possible. Make sure existing tests pass with:
+
+```sh
+bundle exec rake test
+```
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.
...	...	@@ -0,0 +1,51 @@
	1	+# Contributing
	2	+
	3	+First, thanks for wanting to contribute. You’re awesome! :heart:
	4	+
	5	+## Questions
	6	+
	7	+Use [Stack Overflow](https://stackoverflow.com/) with the tag `searchkick`.
	8	+
	9	+## Feature Requests
	10	+
	11	+Create an issue. Start the title with `[Idea]`.
	12	+
	13	+## Issues
	14	+
	15	+Think you’ve discovered an issue?
	16	+
	17	+1. Search existing issues to see if it’s been reported.
	18	+2. Try the `master` branch to make sure it hasn’t been fixed.
	19	+
	20	+```rb
	21	+gem "searchkick", github: "ankane/searchkick"
	22	+```
	23	+
	24	+3. Try the `debug` option when searching. This can reveal useful info.
	25	+
	26	+```ruby
	27	+Product.search("something", debug: true)
	28	+```
	29	+
	30	+If the above steps don’t help, create an issue.
	31	+
	32	+- For incorrect search results, recreate the problem by forking [this gist](https://gist.github.com/ankane/f80b0923d9ae2c077f41997f7b704e5c). Include a link to your gist and the output in the issue.
	33	+- For exceptions, include the complete backtrace.
	34	+
	35	+## Pull Requests
	36	+
	37	+Fork the project and create a pull request. A few tips:
	38	+
	39	+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
	40	+- Follow the existing style. The code should read like it’s written by a single person.
	41	+- Add one or more tests if possible. Make sure existing tests pass with:
	42	+
	43	+```sh
	44	+bundle exec rake test
	45	+```
	46	+
	47	+Feel free to open an issue to get feedback on your idea before spending too much time on it.
	48	+
	49	+---
	50	+
	51	+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.
...	...