diff options
| author | Alex Beregszaszi <alex@rtfs.hu> | 2016-09-09 01:44:14 +0800 |
|---|---|---|
| committer | Alex Beregszaszi <alex@rtfs.hu> | 2016-09-09 23:07:57 +0800 |
| commit | fb856c3f8d402ad73f9a7c2ed52a418396e60cee (patch) | |
| tree | 42bf18eaefaa4c5198708aa8cd9587ab7470a4dc /docs | |
| parent | 8951affb62d3f3ead3f0b24f9026cac1042ab85e (diff) | |
| download | dexon-solidity-fb856c3f8d402ad73f9a7c2ed52a418396e60cee.tar.gz dexon-solidity-fb856c3f8d402ad73f9a7c2ed52a418396e60cee.tar.zst dexon-solidity-fb856c3f8d402ad73f9a7c2ed52a418396e60cee.zip | |
Document versioning behaviour
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installing-solidity.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index ad27e528..42d7bf98 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -6,6 +6,28 @@ Installing Solidity ################### +Versioning +========== + +Solidity versions follow `semantic versioning <https://semver.org>` and in addition to +releases, **nightly development builds** are also made available. The nightly builds +are not guaranteed to be working and despite best efforts they might contain undocumented +and/or broken changes. + +After a release is made, the patch version level is bumped, because we assume that only +patch level changes follow. When changes are merged, the version should be bumped according +to semver and the severity of the change. Finally, a release is always made with the version +of the current nightly build, but without the ``prerelease`` specifier. + +Example: +- 0) the 0.4.0 release is made +- 1) nightly build has a version of 0.4.1 from now on +- 2) non-breaking changes are introduced - no change in version +- 3) a breaking change is introduced - version is bumped to 0.5.0 +- 4) the 0.5.0 release is made + +This behaviour works well with the version pragma. + Browser-Solidity ================ |