Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
May 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions cvat-canvas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand Down
7 changes: 7 additions & 0 deletions cvat-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions cvat-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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``
37 changes: 37 additions & 0 deletions cvat-ui/README.md
Original file line number Diff line number Diff line change
@@ -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