@@ -28,25 +28,34 @@ which *should* be compatible with JSON:API compliant server implementations such
2828
2929Add JR to your application's ` Gemfile ` :
3030
31- gem 'jsonapi-resources'
31+ ```
32+ gem 'jsonapi-resources'
33+ ```
3234
3335And then execute:
3436
35- $ bundle
37+ ``` bash
38+ bundle
39+ ```
3640
3741Or install it yourself as:
3842
39- $ gem install jsonapi-resources
43+ ``` bash
44+ gem install jsonapi-resources
45+ ```
4046
4147** For further usage see the [ v0.10 alpha Guide] ( http://jsonapi-resources.com/v0.10/guide/ ) **
4248
4349## Contributing
4450
51+ 1 . Submit an issue describing any new features you wish it add or the bug you intend to fix
45521 . Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
46- 2 . Create your feature branch (` git checkout -b my-new-feature ` )
47- 3 . Commit your changes (` git commit -am 'Add some feature' ` )
48- 4 . Push to the branch (` git push origin my-new-feature ` )
49- 5 . Create a new Pull Request
53+ 1 . Create your feature branch (` git checkout -b my-new-feature ` )
54+ 1 . Run the full test suite (` rake test ` )
55+ 1 . Fix any failing tests
56+ 1 . Commit your changes (` git commit -am 'Add some feature' ` )
57+ 1 . Push to the branch (` git push origin my-new-feature ` )
58+ 1 . Create a new Pull Request
5059
5160## Did you find a bug?
5261
@@ -58,7 +67,7 @@ and a **code sample** or an **executable test case** demonstrating the expected
5867
5968* If possible, use the relevant bug report templates to create the issue.
6069Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue,
61- and ** paste the content into the issue description** :
70+ and ** paste the content into the issue description or attach as a file ** :
6271 * [ ** Rails 5** issues] ( https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb )
6372
6473
0 commit comments