From 7c43ccdabfff13be89e619a22303717f89603eaf Mon Sep 17 00:00:00 2001 From: kerr Date: Wed, 9 Jan 2019 23:20:09 +0800 Subject: [PATCH] Add how to check binary compatibility. (#26219) --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c7e1dcf88..a85422b831 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -208,6 +208,8 @@ Situations when it may be fine to ignore a MiMa issued warning include: - if it is adding API to classes / traits which are only meant for extension by Akka itself, i.e. should not be extended by end-users - other tricky situations +The binary compatibility of the current changes can be checked by running `sbt +mimaReportBinaryIssues`. + ## Pull request requirements For a pull request to be considered at all it has to meet these requirements: