Commit e68a4ad55d9dca5fb3e7366224e779423236158e
1 parent
7ab7b363
Exists in
master
and in
5 other branches
Updated templates [skip ci]
Showing
5 changed files
with
20 additions
and
54 deletions
Show diff stats
.github/ISSUE_TEMPLATE/bug_report.md
| @@ -7,11 +7,14 @@ assignees: '' | @@ -7,11 +7,14 @@ assignees: '' | ||
| 7 | 7 | ||
| 8 | --- | 8 | --- |
| 9 | 9 | ||
| 10 | +**First** | ||
| 11 | +Search existing issues to see if it’s been reported. | ||
| 12 | + | ||
| 10 | **Describe the bug** | 13 | **Describe the bug** |
| 11 | A clear and concise description of what the bug is. | 14 | A clear and concise description of what the bug is. |
| 12 | 15 | ||
| 13 | **To Reproduce** | 16 | **To Reproduce** |
| 14 | -Use this code to reproduce: | 17 | +Use this code to reproduce when possible: |
| 15 | 18 | ||
| 16 | ```ruby | 19 | ```ruby |
| 17 | require "bundler/inline" | 20 | require "bundler/inline" |
.github/ISSUE_TEMPLATE/feature_request.md
| @@ -7,6 +7,9 @@ assignees: '' | @@ -7,6 +7,9 @@ assignees: '' | ||
| 7 | 7 | ||
| 8 | --- | 8 | --- |
| 9 | 9 | ||
| 10 | +**First** | ||
| 11 | +Search existing issues to see if it’s been discussed. | ||
| 12 | + | ||
| 10 | **Is your feature request related to a problem? Please describe.** | 13 | **Is your feature request related to a problem? Please describe.** |
| 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | 14 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
| 12 | 15 |
| @@ -0,0 +1,11 @@ | @@ -0,0 +1,11 @@ | ||
| 1 | +Thanks for contributing. You’re awesome! :heart: | ||
| 2 | + | ||
| 3 | +A few things to keep in mind: | ||
| 4 | + | ||
| 5 | +- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests. | ||
| 6 | +- Follow the existing style. | ||
| 7 | +- Add one or more tests if possible. Make sure existing tests pass with: | ||
| 8 | + | ||
| 9 | +```sh | ||
| 10 | +bundle exec rake test | ||
| 11 | +``` |
CONTRIBUTING.md
| @@ -1,53 +0,0 @@ | @@ -1,53 +0,0 @@ | ||
| 1 | -# Contributing | ||
| 2 | - | ||
| 3 | -First, thanks for wanting to contribute. You’re awesome! :heart: | ||
| 4 | - | ||
| 5 | -## Help | ||
| 6 | - | ||
| 7 | -We’re not able to provide support through GitHub Issues. If you’re looking for help with your code, try posting on [Stack Overflow](https://stackoverflow.com/questions/tagged/searchkick). | ||
| 8 | - | ||
| 9 | -All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist. | ||
| 10 | - | ||
| 11 | -## Bugs | ||
| 12 | - | ||
| 13 | -Think you’ve discovered a bug? | ||
| 14 | - | ||
| 15 | -1. Search existing issues to see if it’s been reported. | ||
| 16 | -2. Try the `master` branch to make sure it hasn’t been fixed. | ||
| 17 | - | ||
| 18 | -```rb | ||
| 19 | -gem "searchkick", github: "ankane/searchkick" | ||
| 20 | -``` | ||
| 21 | - | ||
| 22 | -3. Try the `debug` option when searching. This can reveal useful info. | ||
| 23 | - | ||
| 24 | -```ruby | ||
| 25 | -Product.search("something", debug: true) | ||
| 26 | -``` | ||
| 27 | - | ||
| 28 | -If the above steps don’t help, create an issue. | ||
| 29 | - | ||
| 30 | -- 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. | ||
| 31 | -- For exceptions, include the complete backtrace. | ||
| 32 | - | ||
| 33 | -## New Features | ||
| 34 | - | ||
| 35 | -If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`. | ||
| 36 | - | ||
| 37 | -## Pull Requests | ||
| 38 | - | ||
| 39 | -Fork the project and create a pull request. A few tips: | ||
| 40 | - | ||
| 41 | -- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests. | ||
| 42 | -- Follow the existing style. The code should read like it’s written by a single person. | ||
| 43 | -- Add one or more tests if possible. Make sure existing tests pass with: | ||
| 44 | - | ||
| 45 | -```sh | ||
| 46 | -bundle exec rake test | ||
| 47 | -``` | ||
| 48 | - | ||
| 49 | -Feel free to open an issue to get feedback on your idea before spending too much time on it. | ||
| 50 | - | ||
| 51 | ---- | ||
| 52 | - | ||
| 53 | -This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution. |
README.md