Skip to content

Commit

Permalink
Added note about api breaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Knetic committed Jul 26, 2016
1 parent 5536328 commit 5d47078
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,13 @@ BenchmarkConstantRegexExpression-12 500000 2599 ns/op
ok
```

API Breaks
--

While this library has very few cases which will ever result in an API break, it can (and [has](https://github.com/Knetic/govaluate/releases/tag/2.0.0)) happened. If you are using this in production, vendor the commit you've tested against. Master branch (while infrequent) _may_ at some point contain API breaking changes, and the author will have no way to communicate these to downstreams.

Releases will explicitly state when an API break happens, and if they do not specify an API break it should be safe to upgrade.

Branching
--

Expand Down

0 comments on commit 5d47078

Please sign in to comment.