mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Go back to Python SemVer
This commit is contained in:
parent
3efc5725b5
commit
ff6f9cf58f
@ -2,8 +2,10 @@
|
|||||||
|
|
||||||
All _notable_ changes to this project will be documented in this file (`CHANGELOG.md`).
|
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**:
|
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).
|
||||||
* Includes:
|
|
||||||
|
The BigchainDB **public API**
|
||||||
|
* includes:
|
||||||
* This definition of **public API**.
|
* This definition of **public API**.
|
||||||
* The configuration defaults, schemas, and paths where configuration files are stored.
|
* The configuration defaults, schemas, and paths where configuration files are stored.
|
||||||
* The Command Line Interface.
|
* 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).
|
* All the endpoints exposed by the HTTP API (including payloads sent to and received from them).
|
||||||
* The WebSocket Event Stream API.
|
* The WebSocket Event Stream API.
|
||||||
* The docker setup.
|
* The docker setup.
|
||||||
* Excludes:
|
* excludes:
|
||||||
* **Everything** marked as `experimental` (even if the feature is part of the **public API**).
|
* **Everything** marked as `experimental` (even if the feature is part of the **public API**).
|
||||||
* The logs generated by the server.
|
* The logs generated by the server.
|
||||||
* The internal API, such as classes, methods, functions.
|
* The internal API, such as classes, methods, functions.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user