root
/
grape-swagger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Moved to the ruby-grape organization.

This commit is contained in:
dblock 2015-08-19 12:12:41 -04:00
parent 6ef288fdf1
commit a91d069d07
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -1,20 +1,20 @@
# 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).
This project is work of [many contributors](https://github.com/ruby-grape/grape-swagger/graphs/contributors).
You're encouraged to submit [pull requests](https://github.com/ruby-grape/grape-swagger/pulls),
[propose features and discuss issues](https://github.com/ruby-grape/grape-swagger/issues).
When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape).
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.
Fork the [project on Github](https://github.com/ruby-grape/grape-swagger) and check out your copy.
```
git clone https://github.com/contributor/grape-swagger.git
cd grape-swagger
git remote add upstream https://github.com/tim-vandecasteele/grape-swagger.git
git remote add upstream https://github.com/ruby-grape/grape-swagger.git
```
## Create a Topic Branch
@ -47,7 +47,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
Implement your feature or bug fix.
Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
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.
@ -85,7 +85,7 @@ git push origin my-feature-branch
## Make a Pull Request
Go to https://github.com/contributor/grape and select your feature branch.
Go to https://github.com/contributor/grape-swagger 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
@ -103,7 +103,7 @@ git push origin my-feature-branch -f
Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
```
* [#123](https://github.com/tim-vandecasteele/grape-swagger/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
* [#123](https://github.com/ruby-grape/grape-swagger/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
```
Amend your previous commit and force push the changes.

6
README.md
View File

@ -1,8 +1,8 @@
# grape-swagger
[![Gem Version](http://img.shields.io/gem/v/grape-swagger.svg)](http://badge.fury.io/rb/grape-swagger)
[![Build Status](http://img.shields.io/travis/tim-vandecasteele/grape-swagger.svg)](https://travis-ci.org/tim-vandecasteele/grape-swagger)
[![Code Climate](https://codeclimate.com/github/tim-vandecasteele/grape-swagger.svg)](https://codeclimate.com/github/tim-vandecasteele/grape-swagger)
[![Gem Version](https://badge.fury.io/rb/grape-swagger.svg)](http://badge.fury.io/rb/grape-swagger)
[![Build Status](https://travis-ci.org/ruby-grape/grape-swagger.svg?branch=master)](https://travis-ci.org/ruby-grape/grape-swagger)
[![Code Climate](https://codeclimate.com/github/ruby-grape/grape-swagger.svg)](https://codeclimate.com/github/ruby-grape/grape-swagger)
## What is grape-swagger?

6
UPGRADING.md
View File

@ -22,7 +22,7 @@ Be aware of https://github.com/ruby-grape/grape/issues/920, currently grape acce
#### Grape-Swagger-Rails
If you're using [grape-swagger-rails](https://github.com/BrandyMint/grape-swagger-rails), remove the `.json` extension from `GrapeSwaggerRails.options.url`.
If you're using [grape-swagger-rails](https://github.com/ruby-grape/grape-swagger-rails), remove the `.json` extension from `GrapeSwaggerRails.options.url`.
For example, change
@ -36,7 +36,7 @@ to
GrapeSwaggerRails.options.url = '/api/v1/swagger_doc'
```
See [#187](https://github.com/tim-vandecasteele/grape-swagger/issues/187) for more information.
See [#187](https://github.com/ruby-grape/grape-swagger/issues/187) for more information.
#### Grape 0.10.0
@ -85,4 +85,4 @@ add_swagger_documentation (
)
```
See [#142](https://github.com/tim-vandecasteele/grape-swagger/pull/142) and documentation section [Markdown in Notes](https://github.com/tim-vandecasteele/grape-swagger#markdown-in-notes) for more information.
See [#142](https://github.com/ruby-grape/grape-swagger/pull/142) and documentation section [Markdown in Notes](https://github.com/ruby-grape/grape-swagger#markdown-in-notes) for more information.