Skip to content

Commit 756fab8

Browse files
committed
Address @gmethvin's feedback: fix Mima link, wording and typos
1 parent 3710908 commit 756fab8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

_overviews/tutorials/binary-compatibility-for-library-authors.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,11 @@ How can we, as library authors, spare our users of runtime errors and dependency
142142

143143
## MiMa - Checking binary compatibility against previous library versions
144144

145-
The [Migration Manager for Scala](https://github.com/typesafehub/migration-manager) (MiMa) is a tool for diagnosing binary incompatibilities between different library versions.
145+
The [Migration Manager for Scala](https://github.com/lightbend/migration-manager) (MiMa) is a tool for diagnosing binary incompatibilities between different library versions.
146146
It works by comparing the class files of two provided JARs and report any binary incompatibilities found.
147147
Both backwards and forwards binary incompatibility can be detected by swapping input order of the JARs.
148148

149-
By incorporating [MiMa SBT plugin](https://github.com/typesafehub/migration-manager/wiki/Sbt-plugin) into your SBT build, you can easily check whether
149+
By incorporating [MiMa SBT plugin](https://github.com/lightbend/migration-manager/wiki/Sbt-plugin) into your SBT build, you can easily check whether
150150
you have accidentally introduced binary incompatible changes. Detailed instruction on how to use the SBT plugin can be found in the link.
151151

152152
We strongly encourage every library author to incorporate MiMa into their continuous integration and release workflow.
@@ -175,7 +175,7 @@ Again, we recommend using MiMa to double check that you have not broken binary c
175175
## Versioning Scheme - Communicating compatibility breakages
176176

177177
Library authors use versioning schemes to communicate compatibility guarantees between library releases to their users. Versioning schemes like [Semantic Versioning](http://semver.org/)(SemVer) allow
178-
users to easily reason about the impact of updating a library, without needing to read the detailed release note.
178+
users to easily reason about the impact of updating a library, without needing to read the detailed release notes.
179179

180180
In the following section, we will outline a versioning scheme based on Semantic Versioning that we **strongly encourage** you to adopt for your libraries. The rules listed below are **in addition** to
181181
Semantic Versioning v2.0.0.
@@ -184,7 +184,7 @@ Semantic Versioning v2.0.0.
184184

185185
* If backward **binary compatibility** is broken, **major version number** must be increased.
186186
* If backward **source compatibility** is broken, **minor version number** must be increased.
187-
* A change in **patch version number** signals **no binary nor source incompatibility**.
187+
* A change in **patch version number** signals **neither binary nor source incompatibility**.
188188
According to SemVer, patch versions should contain only bug fixes that fix incorrect behavior so major behavioral
189189
change in method/classes should result in a minor version bump.
190190
* When major version is `0`, a minor version bump **may contain both source and binary breakages**.

0 commit comments

Comments
 (0)