Skip to content

Commit 0ad63df

Browse files
author
Jeff Cousens
committed
Housekeeping.
- Updating the .gif to match the blog post. - Tidying some language. - Linking to the blog.
1 parent dc7f062 commit 0ad63df

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Swagger::Diff
22

3-
We welcome Pull Requests from everyone!
3+
We welcome pull requests from everyone!
44

55
## Getting Started
66

@@ -12,12 +12,12 @@ We welcome Pull Requests from everyone!
1212
6. Make sure the test suite, including your new tests, passes (`rake`)
1313
7. Commit your changes (`git commit -am 'Add some feature'`)
1414
8. Push to the branch (`git push origin my-new-feature`)
15-
9. Create a new Pull Request
15+
9. Create a new pull request
1616
10. If the Travis build fails, address any issues
1717

1818
## Tips
1919

20-
- All Pull Requests must include test coverage. If you’re not sure how to test
20+
- All pull requests must include test coverage. If you’re not sure how to test
2121
your changes, feel free to ask for help.
2222
- Contributions must conform to the
2323
[Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Specifications are considered backwards compatible if:
2727
- all response attributes in the old specification have the same type in the new
2828
one
2929

30+
Read more on the [Civis Analytics blog](https://civisanalytics.com/blog/engineering/2015/10/02/using-swagger-to-detect-breaking-api-changes/).
31+
3032
## Installation
3133

3234
Add this line to your application's Gemfile:

swagger-diff.gif

-11.4 KB
Loading

0 commit comments

Comments
 (0)