Skip to content

Commit

Permalink
Update READEME.md to discuss versioning strategy
Browse files Browse the repository at this point in the history
This is based on the versioning strategy outlined in:
#6.
  • Loading branch information
Tom Johnson committed Oct 3, 2017
1 parent 14812ce commit 0c633b8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ inherit_gem:
bixby: bixby_default.yml
```
## Versioning & Dependencies
This project depends on `rubocop` and `rubocop-rspec`. It supports versions of those gems pessimistically. Beginning with release `1.0.0`, we will periodically add support for new versions of the dependencies and manage the included cops. When compatibility breaks, the major version of `bixby` will be bumped.

Our goal is to insulate downstream projects from breakage due to pre-1.0 version updates in `rubocop`.

## License

Bixby is available under [the Apache 2.0 license](LICENSE.md).
Expand Down

0 comments on commit 0c633b8

Please sign in to comment.