[tor-commits] [onionoo/master] Start assigning version numbers.

[karsten at torproject.org]

commit 02a20ff7a2eec7fd99a87b50ee554b2acb7eeafe
Author: Karsten Loesing <karsten.loesing at gmx.net>
Date:   Tue Sep 16 14:30:32 2014 +0200

    Start assigning version numbers.
    
    Discussed in #13088.
---
 CONTRIB.md |   19 +++++++++++++++++++
 ChangeLog  |    6 ++++++
 2 files changed, 25 insertions(+)

diff --git a/CONTRIB.md b/CONTRIB.md
index 244d6a1..3daf91a 100644
--- a/CONTRIB.md
+++ b/CONTRIB.md
@@ -7,6 +7,7 @@ It contains the following sections:
  - Whitespace conventions
  - Vagrant-based development environment
  - Documentation overview
+ - Versions
 
 ## Patch format
 
@@ -291,3 +292,21 @@ documentation.
 The purpose is that contributors know what documentation exists, or should
 not exist, and why.
 
+## Versions
+
+Onionoo uses version strings to indicate changes to the protocol or to the
+server implementation.
+A version string consists of three version numbers `x.y.z`:
+
+ - `x` is the major protocol version number and is raised when previously
+required fields are dropped or turned into optional fields, when request
+parameters or response documents are removed, or when there are structural
+changes.
+ - `y` is the minor protocol version number and is raised when new fields,
+request parameters, or response documents are added or optional fields are
+dropped.
+ - `z` is the server version number and is raised when the server
+implementation is changed without affecting the protocol specification.
+
+Changes are added to the `ChangeLog` file in the root directory.
+
diff --git a/ChangeLog b/ChangeLog
new file mode 100644
index 0000000..2a1fe71
--- /dev/null
+++ b/ChangeLog
@@ -0,0 +1,6 @@
+Changes in version ?.?.? - 2014-??-??
+
+
+Changes in version 1.0.0 - 2014-09-16
+ - First assigned version number.
+