Merge pull request #1140 from lgebhardt/github_templates

GitHub templates

Author: lgebhardt

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,24 @@
+## This issue is a (choose one):
+
+- [ ] Problem/bug report.
+- [ ] Feature request.
+- [ ] Request for support. **Note: Please try to avoid submitting issues for support requests. Use [Gitter](https://gitter.im/cerebris/jsonapi-resources) instead.** 
+
+## Checklist before submitting:
+
+- [ ] I've searched for an existing issue.
+- [ ] I've asked my question on [Gitter](https://gitter.im/cerebris/jsonapi-resources) and have not received a satisfactory answer.
+- [ ] I've included a complete [bug report template](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb). This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
+- [ ] The feature I'm asking for is compliant with the [JSON:API](http://jsonapi.org/) spec.
+
+## Description
+
+Choose one section below and delete the other:
+
+### Bug reports:
+
+Please review [Did you find a bug?](https://github.com/cerebris/jsonapi-resources/blob/master/README.md#did-you-find-a-bug) and replace this content with a brief summary of your issue. If you can't submit a [bug report template](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb) please be as thorough as possible when describing your your description. It's helpful to indicate which version of ruby and the JR gem you are using.
+
+### Features:
+
+Please replace this line with a clear writeup of your feature request. Features that break compliance with the [JSON:API](http://jsonapi.org/) spec will probably be closed.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+
+
+### All Submissions:
+
+- [ ] I've checked to ensure there aren't other open [Pull Requests](https://github.com/cerebris/jsonapi-resources/pulls) for the same update/change.
+- [ ] I've submitted a [ticket](https://github.com/cerebris/jsonapi-resources/issues) for my issue if one did not already exist.
+- [ ] My submission passes all tests. (Please run the full test suite locally to cut down on noise from travis failures.)
+- [ ] I've used Github [auto-closing keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) in the commit message or the description.
+- [ ] I've added/updated tests for this change.
+
+### New Feature Submissions:
+
+- [ ] I've submitted an issue that describes this feature, and received the go ahead from the maintainers.
+- [ ] My submission includes new tests.
+- [ ] My submission maintains compliance with [JSON:API](http://jsonapi.org/).
+
+### Bug fixes and Changes to Core Features:
+
+- [ ] I've included an explanation of what the changes do and why I'd like you to include them.
+- [ ] I've provided test(s) that fails without the change.
+
+### Test Plan:
+
+### Reviewer Checklist:
+- [ ] Maintains compliance with JSON:API
+- [ ] Adequate test coverage exists to prevent regressions

README.md

@@ -28,25 +28,34 @@ which *should* be compatible with JSON:API compliant server implementations such
 
 Add JR to your application's `Gemfile`:
 
-    gem 'jsonapi-resources'
+``` 
+gem 'jsonapi-resources'
+```
 
 And then execute:
 
-    $ bundle
+```bash 
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install jsonapi-resources
+```bash 
+gem install jsonapi-resources
+```
 
 **For further usage see the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/)**
 
 ## Contributing
 
+1. Submit an issue describing any new features you wish it add or the bug you intend to fix
 1. Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Run the full test suite (`rake test`)
+1. Fix any failing tests
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
 
 ## Did you find a bug?
 
@@ -58,7 +67,7 @@ and a **code sample** or an **executable test case** demonstrating the expected
 
 * If possible, use the relevant bug report templates to create the issue. 
 Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, 
-and **paste the content into the issue description**:
+and **paste the content into the issue description or attach as a file**:
   * [**Rails 5** issues](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb)