diff --git a/CHANGELOG.md b/CHANGELOG.md index 54aead7f..ee7240aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,10 @@ All _notable_ changes to this project will be documented in this file (`CHANGELOG.md`). -This project adheres to [Semantic Versioning 2](http://semver.org/spec/v2.0.0.html), the BigchainDB **public API**: -* Includes: +This project adheres to [the Python form of Semantic Versioning](https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme) (or at least we try). + +The BigchainDB **public API** +* includes: * This definition of **public API**. * The configuration defaults, schemas, and paths where configuration files are stored. * The Command Line Interface. @@ -11,7 +13,7 @@ This project adheres to [Semantic Versioning 2](http://semver.org/spec/v2.0.0.ht * All the endpoints exposed by the HTTP API (including payloads sent to and received from them). * The WebSocket Event Stream API. * The docker setup. -* Excludes: +* excludes: * **Everything** marked as `experimental` (even if the feature is part of the **public API**). * The logs generated by the server. * The internal API, such as classes, methods, functions.