Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update SemVer policy

Browse Source
This commit is contained in:
vrde 2017-07-26 11:58:44 +02:00
parent 024d3ada8f
commit 7f42e0a3c3
No known key found for this signature in database
GPG Key ID: 6581C7C39B3D397D
1 changed files with 36 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CHANGELOG.md
View File

@ -1,7 +1,20 @@
# Change Log (Release Notes)
All _notable_ changes to this project will be documented in this file (`CHANGELOG.md`).
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).
This project adheres to [Semantic Versioning 2](http://semver.org/spec/v2.0.0.html), the BigchainDB **public API**:
* Includes:
* This definition of **public API**.
* The Command Line Interface.
* The transaction schema.
* All the endpoints exposed by the HTTP API (including payloads sent to and received from them).
* The docker setup.
* 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.
Contributors to this file, please follow the guidelines on [keepachangelog.com](http://keepachangelog.com/).
Note that each version (or "release") is the name of a [Git _tag_](https://git-scm.com/book/en/v2/Git-Basics-Tagging) of a particular commit, so the associated date and time are the date and time of that commit (as reported by GitHub), _not_ the "Uploaded on" date listed on PyPI (which may differ).
For reference, the possible headings are: