Skip to content

Commit 8df5d61

Browse files
authored
Updated README.md files (added info about versioning) (#1490)
* Updated README.md files (added info about versioning) * Typos
1 parent 9740ad7 commit 8df5d61

File tree

4 files changed

+58
-7
lines changed

4 files changed

+58
-7
lines changed

cvat-canvas/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
The CVAT module written in TypeScript language.
55
It presents a canvas to viewing, drawing and editing of annotations.
66

7+
## Versioning
8+
If you make changes in this package, please do following:
9+
10+
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
11+
- After changing API (backward compatible new features) do: ``npm version minor``
12+
- After changing API (changes that break backward compatibility) do: ``npm version major``
13+
714
## Commands
815
- Building of the module from sources in the ```dist``` directory:
916

@@ -12,13 +19,6 @@ npm run build
1219
npm run build -- --mode=development # without a minification
1320
```
1421

15-
- Updating of a module version:
16-
```bash
17-
npm version patch # updated after minor fixes
18-
npm version minor # updated after major changes which don't affect API compatibility with previous versions
19-
npm version major # updated after major changes which affect API compatibility with previous versions
20-
```
21-
2222
## Using
2323

2424
Canvas itself handles:

cvat-core/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
This CVAT module is a clien-side JavaScipt library to management of objects, frames, logs, etc.
55
It contains the core logic of the Computer Vision Annotation Tool.
66

7+
## Versioning
8+
If you make changes in this package, please do following:
9+
10+
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
11+
- After changing API (backward compatible new features) do: ``npm version minor``
12+
- After changing API (changes that break backward compatibility) do: ``npm version major``
13+
714
### Commands
815

916
- Dependencies installation

cvat-data/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,10 @@ npm run build # build with minification
55
npm run build -- --mode=development # build without minification
66
npm run server # run debug server
77
```
8+
9+
## Versioning
10+
If you make changes in this package, please do following:
11+
12+
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
13+
- After changing API (backward compatible new features) do: ``npm version minor``
14+
- After changing API (changes that break backward compatibility) do: ``npm version major``

cvat-ui/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# cvat-ui module
2+
3+
## Description
4+
This is a client UI for Computer Vision Annotation Tool based on React, Redux and Antd
5+
6+
## Versioning
7+
If you make changes in this package, please do following:
8+
9+
- After not important changes (typos, bug fixes, refactoring) do: ``npm version patch``
10+
- After adding new features do: ``npm version minor``
11+
- After significant UI redesign do: ``npm version major``
12+
13+
Important: If you have changed versions for ``cvat-core``, ``cvat-canvas``, ``cvat-data``,
14+
you also need to do ``npm install`` to update ``package-lock.json``
15+
16+
## Commands
17+
- Installing dependencies:
18+
19+
```bash
20+
cd ../cvat-core && npm install && cd - && npm install
21+
```
22+
23+
- Running development UI server with autorebuild on change
24+
25+
```bash
26+
npm start
27+
```
28+
29+
- Building the module from sources in the ```dist``` directory:
30+
31+
```bash
32+
npm run build
33+
npm run build -- --mode=development # without a minification
34+
```
35+
36+
Important: You also have to run CVAT REST API server (please read ``CONTRIBUTING.md``)
37+
to correct working since UI gets all necessary data (tasks, users, annotations) from there

0 commit comments

Comments
 (0)