From e68a4ad55d9dca5fb3e7366224e779423236158e Mon Sep 17 00:00:00 2001 From: Andrew Kane Date: Fri, 19 Jun 2020 19:17:32 -0700 Subject: [PATCH] Updated templates [skip ci] --- .github/ISSUE_TEMPLATE/bug_report.md | 5 ++++- .github/ISSUE_TEMPLATE/feature_request.md | 3 +++ .github/pull_request_template.md | 11 +++++++++++ CONTRIBUTING.md | 53 ----------------------------------------------------- README.md | 2 ++ 5 files changed, 20 insertions(+), 54 deletions(-) create mode 100644 .github/pull_request_template.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8926f23..f8ec13a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,11 +7,14 @@ assignees: '' --- +**First** +Search existing issues to see if it’s been reported. + **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** -Use this code to reproduce: +Use this code to reproduce when possible: ```ruby require "bundler/inline" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..600aa17 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,6 +7,9 @@ assignees: '' --- +**First** +Search existing issues to see if it’s been discussed. + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0701f0a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +Thanks for contributing. You’re awesome! :heart: + +A few things to keep in mind: + +- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests. +- Follow the existing style. +- Add one or more tests if possible. Make sure existing tests pass with: + +```sh +bundle exec rake test +``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 4cf22e5..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,53 +0,0 @@ -# Contributing - -First, thanks for wanting to contribute. You’re awesome! :heart: - -## Help - -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). - -All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist. - -## Bugs - -Think you’ve discovered a bug? - -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. - -- 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. - -## New Features - -If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`. - -## 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. diff --git a/README.md b/README.md index ec7c95a..6a75677 100644 --- a/README.md +++ b/README.md @@ -2040,3 +2040,5 @@ cd searchkick bundle install bundle exec rake test ``` + +Feel free to open an issue to get feedback on your idea before spending too much time on it. -- libgit2 0.21.0