Contributing to this project

This section contains documents for CVAT developers.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Development environment

Installing a development environment for different operating systems.

Setup additional components in development environment

Deploying a DL model as a serverless function and Cypress tests.

JavaScript/Typescript coding style

Information about JavaScript/Typescript coding style that is used in CVAT development.

Branching model

Information about the branching model that is used in the project.

Using the issue tracker

Information and rules for using the issue tracker.

Bug reports

Guidelines and an example of how to report a bug.

Feature requests

Information on requesting new features.

Pull requests

Instructions on how to create a pull request.

How to add a new annotation format support

Instructions on adding support for new annotation formats. This section on GitHub.

REST API design principles

Information on using the REST API scheme and principles of its design.