Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
R
rspec-rails-swagger
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open-source
rspec-rails-swagger
Commits
47a5c409
Commit
47a5c409
authored
Oct 02, 2016
by
andrew morton
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add contributing guide and suggest swagger_engine
parent
a48ef4a2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
17 additions
and
1 deletion
+17
-1
CONTRIBUTING.md
CONTRIBUTING.md
+15
-0
README.md
README.md
+2
-1
No files found.
CONTRIBUTING.md
0 → 100644
View file @
47a5c409
# Contributing
## Running tests
The
`make_site.sh`
script will create a test site for a specific version of
Rails and run the tests:
```
RAILS_VERSION=4.2.0
./make_site.sh
```
Once the test site is created you can just re-run the tests:
```
bundle exec rspec
```
README.md
View file @
47a5c409
...
@@ -61,4 +61,5 @@ bundle exec rake swagger
...
@@ -61,4 +61,5 @@ bundle exec rake swagger
```
```
Now you can use Swagger UI or the renderer of your choice to display the
Now you can use Swagger UI or the renderer of your choice to display the
formatted documentation.
formatted documentation.
[
swagger_engine
](
https://github.com/batdevis/swagger_engine
)
works pretty well and supports multiple documents.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment