From 0075824697f5064d747ceb7d72ebb9d7d1e2dfca Mon Sep 17 00:00:00 2001 From: James Mead Date: Tue, 1 Nov 2022 12:42:21 +0000 Subject: [PATCH] Add README section re semantic versioning Closes #577. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0fa50541..ab6b4f1e 100644 --- a/README.md +++ b/README.md @@ -302,6 +302,12 @@ See the [documentation](https://mocha.jamesmead.org/Mocha/Configuration.html) fo Only the following values are currently recognized and have an effect: * `debug`: Enables a debug mode which will output backtraces for each deprecation warning. This is useful for finding where in the test suite the deprecated calls are. +### Semantic versioning + +* Every effort is made to comply with [semantic versioning](https://semver.org/). +* However, this only applies to the behaviour documented in the public API. +* The documented public API does *not* include the content or format of messsages displayed to the user, e.g. assertion failure messages. + ### Useful Links * [Official Documentation](https://mocha.jamesmead.org)