You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
<!-- Raise an issue to propose your change (https://github.com/opencv/cvat/issues). It helps to avoid duplication of efforts from multiple independent contributors. Discuss your ideas with maintainers to be sure that changes will be approved and merged. Read the [Contribution guide](https://opencv.github.io/cvat/docs/contributing/). --> <!-- Provide a general summary of your changes in the Title above --> ### Motivation and context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. Describe your changes in detail, add screenshots. --> ### How has this been tested? <!-- Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc. --> ### Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. If an item isn't applicable for some reason, then ~~explicitly strikethrough~~ the whole line. If you don't do that, GitHub will show incorrect progress for the pull request. If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] I submit my changes into the `develop` branch - [ ] I have added a description of my changes into the [CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md) file - [ ] I have updated the documentation accordingly - [ ] I have added tests to cover my changes - [ ] I have linked related issues (see [GitHub docs]( https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)) - [ ] I have increased versions of npm packages if it is necessary ([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning), [cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning), [cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning) and [cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning)) ### License - [ ] I submit _my code changes_ under the same [MIT License]( https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. |
3 years ago | |
|---|---|---|
| .. | ||
| docs | 6 years ago | |
| src | 3 years ago | |
| tests | 3 years ago | |
| .dockerignore | 6 years ago | |
| .eslintrc.js | 3 years ago | |
| README.md | 3 years ago | |
| jest.config.js | 4 years ago | |
| package.json | 3 years ago | |
| tsconfig.json | 3 years ago | |
| webpack.config.js | 3 years ago | |
README.md
Module CVAT-CORE
Description
This CVAT module is a client-side JavaScript library for 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:
yarn version --patch - After changing API (backward compatible new features) do:
yarn version --minor - After changing API (changes that break backward compatibility) do:
yarn version --major
Commands
- Dependencies installation
yarn ci --frozen-lockfile
- Building the module from sources in the
distdirectory:
yarn run build
yarn run build --mode=development # without a minification
- Running of tests:
yarn run test
- Updating of a module version:
yarn version --patch # updated after minor fixes
yarn version --minor # updated after major changes which don't affect API compatibility with previous versions
yarn version --major # updated after major changes which affect API compatibility with previous versions
Visual studio code configurations:
- cvat.js debug starts debugging with entrypoint api.js
- cvat.js test builds library and runs entrypoint tests.js