Updated README.md files (added info about versioning) (#1490)

* Updated README.md files (added info about versioning) * Typos
cvat-ai · May 5, 2020 · 8df5d61 · 8df5d61
1 parent 9740ad7
commit 8df5d61
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 7 deletions.
diff --git a/cvat-canvas/README.md b/cvat-canvas/README.md
@@ -4,6 +4,13 @@
 The CVAT module written in TypeScript language.
 It presents a canvas to viewing, drawing and editing of annotations.
 
+## Versioning
+If you make changes in this package, please do following:
+
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
+- After changing API (backward compatible new features) do: ``npm version minor``
+- After changing API (changes that break backward compatibility) do: ``npm version major``
+
 ## Commands
 - Building of the module from sources in the ```dist``` directory:
 
@@ -12,13 +19,6 @@ npm run build
 npm run build -- --mode=development     # without a minification
 ```
 
-- Updating of a module version:
-```bash
-npm version patch   # updated after minor fixes
-npm version minor   # updated after major changes which don't affect API compatibility with previous versions
-npm version major   # updated after major changes which affect API compatibility with previous versions
-```
-
 ## Using
 
 Canvas itself handles:

diff --git a/cvat-core/README.md b/cvat-core/README.md
@@ -4,6 +4,13 @@
 This CVAT module is a clien-side JavaScipt library to management of objects, frames, logs, etc.
 It contains the core logic of the Computer Vision Annotation Tool.
 
+## Versioning
+If you make changes in this package, please do following:
+
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
+- After changing API (backward compatible new features) do: ``npm version minor``
+- After changing API (changes that break backward compatibility) do: ``npm version major``
+
 ### Commands
 
 - Dependencies installation

diff --git a/cvat-data/README.md b/cvat-data/README.md
@@ -5,3 +5,10 @@ npm run build  # build with minification
 npm run build -- --mode=development     # build without minification
 npm run server # run debug server
 ```
+
+## Versioning
+If you make changes in this package, please do following:
+
+- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
+- After changing API (backward compatible new features) do: ``npm version minor``
+- After changing API (changes that break backward compatibility) do: ``npm version major``
diff --git a/cvat-ui/README.md b/cvat-ui/README.md
@@ -0,0 +1,37 @@
+# cvat-ui module
+
+## Description
+This is a client UI for Computer Vision Annotation Tool based on React, Redux and Antd
+
+## Versioning
+If you make changes in this package, please do following:
+
+- After not important changes (typos, bug fixes, refactoring) do: ``npm version patch``
+- After adding new features do: ``npm version minor``
+- After significant UI redesign do: ``npm version major``
+
+Important: If you have changed versions for ``cvat-core``, ``cvat-canvas``, ``cvat-data``, 
+you also need to do ``npm install`` to update ``package-lock.json``
+
+## Commands
+- Installing dependencies:
+
+```bash
+cd ../cvat-core && npm install && cd - && npm install
+```
+
+- Running development UI server with autorebuild on change
+
+```bash
+npm start
+```
+
+- Building the module from sources in the ```dist``` directory:
+
+```bash
+npm run build
+npm run build -- --mode=development     # without a minification
+```
+
+Important: You also have to run CVAT REST API server (please read ``CONTRIBUTING.md``)
+to correct working since UI gets all necessary data (tasks, users, annotations) from there