diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2017-10-14 15:33:56 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2017-10-14 15:38:00 +0200 |
commit | 5928968c8fa5f9acace421583979313334eaab04 (patch) | |
tree | ddcadcd467e52794885639d71bbd3594e8649c8f | |
parent | 2de3c512e3ade29dc89a4935cd91d505a2ddfdc7 (diff) |
Explain versioning conventions
-rw-r--r-- | doc/src/03010-conventions.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/src/03010-conventions.md b/doc/src/03010-conventions.md index f6ff3016..f9a4d09a 100644 --- a/doc/src/03010-conventions.md +++ b/doc/src/03010-conventions.md @@ -7,6 +7,17 @@ works. Lets work our way up from the store and how to extend it to the commandline user interface. +## Versioning + +All imag crates are versioned with the same version number until we reach some +`"1.0.0"` version. +This means that all imag tools are only tested for compatibility with libraries +and such if their version numbers match. +It might not be possible to import one imag library in version 0.3.0 and another +one in 0.4.0 and make them work together. +It also means that if new tools are introduced into the imag codebase, they +might start with their first version not at 0.1.0 but at something like 0.5.0. + ## Store and Entry functionality A `Entry` does not offer much functionality by itself. So its the job of |