Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
davetapley committed Sep 12, 2014
2 parents bdae185 + 19001f3 commit fc7a2c9
Show file tree
Hide file tree
Showing 35 changed files with 1,477 additions and 527 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ test/dummy/db/*.sqlite3
test/dummy/log/*.log
test/dummy/tmp/
test/dummy/.sass-cache
Gemfile.lock

# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
#
Expand Down
2 changes: 1 addition & 1 deletion .ruby-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
ruby-2.0.0-p353
ruby-2.1.2
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ rvm:
- 1.9.3
- 2.0.0
- 2.1.2
- rbx-2
- rbx-2.2.10


28 changes: 25 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,35 @@
### Next Release
### 0.8.1 (Next)

* Your contribution here.

### 0.8.0 (August 30, 2014)

#### Features

* [#139](https://github.com/tim-vandecasteele/grape-swagger/pull/139): Added support for `Rack::Multipart::UploadedFile` parameters - [@timgluz](https://github.com/timgluz).
* [#136](https://github.com/tim-vandecasteele/grape-swagger/pull/136), [#94](https://github.com/tim-vandecasteele/grape-swagger/pull/94): Recurse combination of namespaces when using mounted apps - [@renier](https://github.com/renier).
* [#100](https://github.com/tim-vandecasteele/grape-swagger/pull/100): Added ability to specify a nickname for an endpoint - [@lhorne](https://github.com/lhorne).
* [#94](https://github.com/tim-vandecasteele/grape-swagger/pull/94): Added support for namespace descriptions - [@renier](https://github.com/renier).
* [#110](https://github.com/tim-vandecasteele/grape-swagger/pull/110), [#111](https://github.com/tim-vandecasteele/grape-swagger/pull/111) - Added `responseModel` support - [@bagilevi](https://github.com/bagilevi).
* [#114](https://github.com/tim-vandecasteele/grape-swagger/pull/114): Added support for generating nested models from composed Grape Entities - [@dspaeth-faber](https://github.com/dspaeth-faber).
* [#124](https://github.com/tim-vandecasteele/grape-swagger/pull/124): Added ability to change the description and parameters of the API endpoints generated by grape-swagger - [@dblock](https://github.com/dblock).
* [#128](https://github.com/tim-vandecasteele/grape-swagger/pull/128): Combine global models and endpoint entities - [@dspaeth-faber](https://github.com/dspaeth-faber).
* [#132](https://github.com/tim-vandecasteele/grape-swagger/pull/132): Addes support for enum values in entity documentation and form parameters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki).
* [#142](https://github.com/tim-vandecasteele/grape-swagger/pull/142), [#143](https://github.com/tim-vandecasteele/grape-swagger/pull/143): Added support for kramdown, redcarpet and custom formatters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki).

#### Fixes

* [#105](https://github.com/tim-vandecasteele/grape-swagger/pull/105): Fixed compatibility with Swagger-UI - [@CraigCottingham](https://github.com/CraigCottingham).
* [#87](https://github.com/tim-vandecasteele/grape-swagger/pull/87): Fixed mapping of `default` to `defaultValue` - [@m-o-e](https://github.com/m-o-e).
* [#127](https://github.com/tim-vandecasteele/grape-swagger/pull/127): Fixed `undefined method 'reject' for nil:NilClass` error for an invalid route, now returning 404 Not Found - [@dblock](https://github.com/dblock).
* [#135](https://github.com/tim-vandecasteele/grape-swagger/pull/135): Fixed model inclusion in models with aliased references - [@cdarne](https://github.com/cdarne).

#### Dev

* [#126](https://github.com/tim-vandecasteele/grape-swagger/pull/126): Rewritten demo in the `test` folder with CORS enabled - [@dblock](https://github.com/dblock).
* Rewritten .gemspec and removed Jeweler - [@dblock](https://github.com/dblock).
* Added `GrapeEntity::VERSION` - [@dblock](https://github.com/dblock).
* Added `GrapeSwagger::VERSION` - [@dblock](https://github.com/dblock).
* Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
* Your Contribution Here

### 0.7.2 (February 6, 2014)

Expand Down
52 changes: 30 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Contributing to Grape-Swagger
=============================
# Contributing to Grape-Swagger

This project is work of [many contributors](https://github.com/tim-vandecasteele/grape-swagger/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/tim-vandecasteele/grape-swagger/pulls), [propose features and discuss issues](https://github.com/tim-vandecasteele/grape-swagger/issues). When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape).
This project is work of [many contributors](https://github.com/tim-vandecasteele/grape-swagger/graphs/contributors).
You're encouraged to submit [pull requests](https://github.com/tim-vandecasteele/grape-swagger/pulls),
[propose features and discuss issues](https://github.com/tim-vandecasteele/grape-swagger/issues).
When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape).

#### Fork the Project
In the examples below, substitute your Github username for `contributor` in URLs.

## Fork the Project

Fork the [project on Github](https://github.com/tim-vandecasteele/grape-swagger) and check out your copy.

Expand All @@ -13,7 +17,7 @@ cd grape-swagger
git remote add upstream https://github.com/tim-vandecasteele/grape-swagger.git
```

#### Create a Topic Branch
## Create a Topic Branch

Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.

Expand All @@ -23,7 +27,7 @@ git pull upstream master
git checkout -b my-feature-branch
```

#### Bundle Install and Test
## Bundle Install and Test

Ensure that you can build the project and run tests.

Expand All @@ -32,29 +36,32 @@ bundle install
bundle exec rake
```

#### Write Tests
## Write Tests

Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec](spec).
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
Add to [spec](spec).

We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.

#### Write Code
## Write Code

Implement your feature or bug fix.

Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
Run `bundle exec rubocop` and fix any style issues highlighted.

Make sure that `bundle exec rake` completes without errors.

#### Write Documentation
## Write Documentation

Document any external behavior in the [README](README.md).

#### Update Changelog
## Update Changelog

Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
Make it look like every other line, including your name and link to your Github account.

#### Commit Changes
## Commit Changes

Make sure git knows your name and email address:

Expand All @@ -70,17 +77,18 @@ git add ...
git commit
```

#### Push
## Push

```
git push origin my-feature-branch
```

#### Make a Pull Request
## Make a Pull Request

Go to https://github.com/contributor/grape and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
Go to https://github.com/contributor/grape and select your feature branch.
Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.

#### Rebase
## Rebase

If you've been working on a change for a while, rebase with upstream/master.

Expand All @@ -90,7 +98,7 @@ git rebase upstream/master
git push origin my-feature-branch -f
```

#### Update CHANGELOG Again
## Update CHANGELOG Again

Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.

Expand All @@ -105,14 +113,14 @@ git commit --amend
git push origin my-feature-branch -f
```

#### Check on Your Pull Request
## Check on Your Pull Request

Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.

#### Be Patient
## Be Patient

It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!

#### Thank You
## Thank You

Please do know that we really appreciate and value your time and work. We love you, really.
108 changes: 0 additions & 108 deletions Gemfile.lock

This file was deleted.

Loading

0 comments on commit fc7a2c9

Please sign in to comment.