[tor-commits] [sbws/master] Remove versioning from README

juga at torproject.org juga at torproject.org
Tue Sep 25 09:48:10 UTC 2018


commit 2aa8266fc5a6bf1f60d1c1386dac4f0b41315ca2
Author: juga0 <juga at riseup.net>
Date:   Fri Sep 14 16:48:46 2018 +0000

    Remove versioning from README
    
    it is usually found in CONTRIBUTING
---
 README.md | 41 -----------------------------------------
 1 file changed, 41 deletions(-)

diff --git a/README.md b/README.md
index f0fe0ae..4c1f1b0 100644
--- a/README.md
+++ b/README.md
@@ -38,47 +38,6 @@ also online at https://sbws.readthedocs.io and
 - `tests/integration/` more complex tests and/or tests that require Tor to be running
 - `tests/testnets/` scripts and code for running mini Tor networks locally
 
-## Boring things
-
-### Versioning
-
-This project follows [semantic versioning][] and thus every major version has
-the potential for breaking changes. You can find information about what those
-are at the following places.
-
-- In the CHANGELOG
-
-[semantic versioning]: https://semver.org/
-
-In addition to the overall semantic version for sbws as a whole, there is a
-simple integer version for the format in which results are stored.
-Incrementing this integer requires a major version change for sbws. (Note that
-the reverse is **not** true: a major sbws version change does not require the
-integer version for the result format to change)
-
-**Note**: In semantic versioning, "3.4.1-dev" comes **before** "3.4.1". With
-this in mind and assuming the current version is "3.4.1-dev": in the last few
-commits leading up to a new release, the version will be updated to
-
-- "3.4.1" if only bug fixes
-- "3.5.0" if bug fixes and/or backwards-compatible additions/changes
-- "4.0.0" if bug fixes and/or backwards-compatible additions/changes and/or
-  backwards-**in**compatible additions/changes
-
-Say the version is updated to "3.5.0". The commit **immediately** after the
-tagged release should update the version to "3.5.1-dev".
-
-**Note**: Before version 1.0.0, we will make an effort to follow semver with a
-prepended "0.". For example, "0.2.3" to "0.3.0" probably had a major breaking
-change. However, we don't promise this will be followed well. Only trust the
-semantic meaning of version numbers when they have reached 1.0.0. Don't worry,
-we'll be 1.0.0 before we expect a full deployment on the real Tor network.
-(Oh god please don't make me eat my words).
-
-To the best of my knowledge, everything said in this section except our
-conventions regarding version bump commit timing is standard semantic
-versioning and spelled out in the [link above][semantic versioning].
-
 ### The public API for sbws
 
 As required by semantic versioning, the public API for sbws will not change





More information about the tor-commits mailing list