From 590a029ac896d3d2dbdf2cfbc8d6a3f17dbdc58c Mon Sep 17 00:00:00 2001 From: dB Date: Thu, 5 Feb 2015 07:11:59 -0500 Subject: [PATCH] Added CHANGELOG. --- CHANGELOG.md | 38 ++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 18 ++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..14290de --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,38 @@ +### Next + +* [41](https://github.com/BrandyMint/grape-swagger-rails/pull/41): Fixed compatibility with grape-swagger 0.8.0 - [@dblock](https://github.com/dblock). +* Your contribution here. + +### 0.0.10 (September 30, 2014) + +* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: make the dummy app runnable - [@dblock](https://github.com/dblock). +* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: headers default to nil - [@dblock](https://github.com/dblock). +* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Added support for GrapeSwaggerRails.options.headers - [@dblock](https://github.com/dblock). +* [#31](https://github.com/BrandyMint/grape-swagger-rails/pull/31): Get Swagger-UI from dist - [@dblock](https://github.com/dblock). +* [#29](https://github.com/BrandyMint/grape-swagger-rails/pull/29): Add Rails 4.1 support - [@aaronchi](https://github.com/aaronchi). +* [#21](https://github.com/BrandyMint/grape-swagger-rails/pull/21): Corrected initializer paths - [@mrclmrvn](https://github.com/mrclmrvn). +* [#23](https://github.com/BrandyMint/grape-swagger-rails/pull/23): Added auth bearer support - [@shinnyx](https://github.com/shinnyx). +* [#14](https://github.com/BrandyMint/grape-swagger-rails/pull/14): Added app_name to configure title of the app - [@ghilead](https://github.com/ghilead). +* [#12](https://github.com/BrandyMint/grape-swagger-rails/pull/12): Fix: SwaggerUI url is combined with appUrl - [@ghilead](https://github.com/ghilead). + +### 0.0.8 (February 6, 2014) + +* [#11](https://github.com/BrandyMint/grape-swagger-rails/pull/11): Fixed image loading - [@bitboxer](https://github.com/bitboxer). + +### 0.0.7 (February 5, 2014) + +* [#7](https://github.com/BrandyMint/grape-swagger-rails/pull/7): Updated to Swagger-UI 2.0.3 - [@joelvh](https://github.com/joelvh). +* [#6](https://github.com/BrandyMint/grape-swagger-rails/pull/6): Added appName and appUrl configuration options - [@swistaczek](https://github.com/swistaczek). + +### 0.0.4 (July 16, 2013) + +* Configure discoveryUrl from Rails - [@dapi](https://github.com/dapi). +* Added default support for all HTTP methods - [@mtavaresOS](https://github.com/mtavaresOS). + +### 0.0.3 (May 24, 2013) + +* Converted to Rails Engine - [@unloved](https://github.com/unloved). + +### 0.0.1 (April 5, 2013) + +* Initial public release - [@radanisk](https://github.com/Radanisk). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e27ba49..fec9001 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,11 @@ Navigate to http://localhost:3000/swagger. Document any external behavior in the [README](README.md). +## 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. + ## Push ``` @@ -84,6 +89,19 @@ git push origin my-feature-branch 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. +## Update CHANGELOG Again + +Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows. + +``` +* [#123](https://github.com/TinkerDev/grape-swagger-rails/pull/123): Reticulated splines - [@contributor](https://github.com/contributor). +``` + +Amend your previous commit and force push the changes. + +``` +git commit --amend +git push origin my-feature-branch -f ## Rebase If you've been working on a change for a while, rebase with upstream/master.