forked from cvat-ai/cvat
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Bug has been fixed: impossible to lock/occlude object in AAM * Bug has been fixed: invisible points actually are visible * Bug has been fixed: impossible to close points after editing (cvat-ai#98) * doc: grammatical cleanup of README.md (cvat-ai#107) * Add info about development environment into CONTRIBUTING.md (cvat-ai#110) * Now we store virtual URL instead of update it in the browser address bar (cvat-ai#112) * Copy URL, Frame URL and object URL functionality in a context menu * Bug has been fixed: label UIs don't update after changelabel (cvat-ai#109) * Common escape button for exit from creating/groupping/merging/pasting/aam * Switch outside/keyframe shortkeys * Fix django vulnerability (cvat-ai#121) * Add analytics component (cvat-ai#118) * Incremental save of annotations (cvat-ai#120) * Create task timeout 1h -> 4h. (cvat-ai#136) * OpenVino integration (cvat-ai#134) * Update README.md (cvat-ai#138) * Add an extra field into meta section of a dump file (cvat-ai#149) * Job status was implemented (cvat-ai#153) * Back link to task from annotation view (cvat-ai#156) * Change a task with labels and attributes in admin panel (cvat-ai#157) * Permissions per tasks and jobs (cvat-ai#185) * Fix context menu, text visibility for small images (cvat-ai#202) * Fixed: both context menu are opened simultaneously * Fixed: shape can be unavailable behind text * Fixed: invisible text outside frame * Fix upload big xml files for tasks (cvat-ai#199) * Add Questions section to Readme.md (cvat-ai#226) * Fixed labels order (cvat-ai#242) * Propagate behaviour has been updated in cases with a different resolution (cvat-ai#246) * Updated the guide and images (cvat-ai#241) * Fix number attribute for float numbers. (cvat-ai#258)
- Loading branch information
Showing
154 changed files
with
5,569 additions
and
2,507 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,196 @@ | ||
| # How to contribute to Computer Vision Annotation Tool (CVAT) | ||
| # Contributing to this project | ||
|
|
||
| When contributing to this repository, please first discuss the change you wish to make via issue, | ||
| email, or any other method with the owners of this repository before making a change. | ||
| 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 | ||
|
|
||
| Next steps should work on clear Ubuntu 18.04. | ||
|
|
||
| - Install necessary dependencies: | ||
|
|
||
| ```sh | ||
| $ sudo apt-get install -y curl redis-server python3-dev python3-pip python3-venv libldap2-dev libsasl2-dev | ||
| ``` | ||
|
|
||
| - Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions) for development | ||
|
|
||
| - Install CVAT on your local host: | ||
|
|
||
| ```sh | ||
| $ git clone https://github.com/opencv/cvat | ||
| $ cd cvat && mkdir logs keys | ||
| $ python3 -m venv .env | ||
| $ . .env/bin/activate | ||
| $ pip install -U pip wheel | ||
| $ pip install -r cvat/requirements/development.txt | ||
| $ python manage.py migrate | ||
| $ python manage.py collectstatic | ||
| ``` | ||
|
|
||
| - Create a super user for CVAT: | ||
|
|
||
| ```sh | ||
| $ python manage.py createsuperuser | ||
| Username (leave blank to use 'django'): *** | ||
| Email address: *** | ||
| Password: *** | ||
| Password (again): *** | ||
| ``` | ||
|
|
||
| - Run Visual Studio Code from the virtual environment | ||
|
|
||
| ``` | ||
| $ code . | ||
| ``` | ||
|
|
||
| - Inside Visual Studio Code install [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) and [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) extensions | ||
|
|
||
| - Reload Visual Studio Code | ||
|
|
||
| - Select `CVAT Debugging` configuration and start debugging (F5) | ||
|
|
||
| You have done! Now it is possible to insert breakpoints and debug server and client of the tool. | ||
|
|
||
| ## Branching model | ||
|
|
||
| The project uses [a successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model). | ||
| Thus it has a couple of branches. Some of them are described below: | ||
|
|
||
| - `origin/master` to be the main branch where the source code of | ||
| HEAD always reflects a production-ready state. | ||
| - `origin/develop` to be the main branch where the source code of | ||
| HEAD always reflects a state with the latest delivered development | ||
| changes for the next release. Some would call this the “integration branch”. | ||
|
|
||
| ## Using the issue tracker | ||
|
|
||
| The issue tracker is the preferred channel for [bug reports](#bugs), | ||
| [features requests](#features) and [submitting pull | ||
| requests](#pull-requests), but please respect the following restrictions: | ||
|
|
||
| * Please **do not** use the issue tracker for personal support requests (use | ||
| [Stack Overflow](https://stackoverflow.com)). | ||
|
|
||
| * Please **do not** derail or troll issues. Keep the discussion on topic and | ||
| respect the opinions of others. | ||
|
|
||
| <a name="bugs"></a> | ||
| ## Bug reports | ||
|
|
||
| A bug is a _demonstrable problem_ that is caused by the code in the repository. | ||
| Good bug reports are extremely helpful - thank you! | ||
|
|
||
| Guidelines for bug reports: | ||
|
|
||
| 1. **Use the GitHub issue search** — check if the issue has already been | ||
| reported. | ||
|
|
||
| 2. **Check if the issue has been fixed** — try to reproduce it using the | ||
| latest `develop` branch in the repository. | ||
|
|
||
| 3. **Isolate the problem** — ideally create a reduced test case. | ||
|
|
||
| A good bug report shouldn't leave others needing to chase you up for more | ||
| information. Please try to be as detailed as possible in your report. What is | ||
| your environment? What steps will reproduce the issue? What browser(s) and OS | ||
| experience the problem? What would you expect to be the outcome? All these | ||
| details will help people to fix any potential bugs. | ||
|
|
||
| Example: | ||
|
|
||
| > Short and descriptive example bug report title | ||
| > | ||
| > A summary of the issue and the browser/OS environment in which it occurs. If | ||
| > suitable, include the steps required to reproduce the bug. | ||
| > | ||
| > 1. This is the first step | ||
| > 2. This is the second step | ||
| > 3. Further steps, etc. | ||
| > | ||
| > | ||
| > Any other information you want to share that is relevant to the issue being | ||
| > reported. This might include the lines of code that you have identified as | ||
| > causing the bug, and potential solutions (and your opinions on their | ||
| > merits). | ||
| <a name="features"></a> | ||
| ## Feature requests | ||
|
|
||
| Feature requests are welcome. But take a moment to find out whether your idea | ||
| fits with the scope and aims of the project. It's up to *you* to make a strong | ||
| case to convince the project's developers of the merits of this feature. Please | ||
| provide as much detail and context as possible. | ||
|
|
||
| <a name="pull-requests"></a> | ||
| ## Pull requests | ||
|
|
||
| Good pull requests - patches, improvements, new features - are a fantastic | ||
| help. They should remain focused in scope and avoid containing unrelated | ||
| commits. | ||
|
|
||
| **Please ask first** before embarking on any significant pull request (e.g. | ||
| implementing features, refactoring code, porting to a different language), | ||
| otherwise you risk spending a lot of time working on something that the | ||
| project's developers might not want to merge into the project. | ||
|
|
||
| Please adhere to the coding conventions used throughout a project (indentation, | ||
| accurate comments, etc.) and any other requirements (such as test coverage). | ||
|
|
||
| Follow this process if you'd like your work considered for inclusion in the | ||
| project: | ||
|
|
||
| 1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, | ||
| and configure the remotes: | ||
|
|
||
| ```bash | ||
| # Clone your fork of the repo into the current directory | ||
| git clone https://github.com/<your-username>/<repo-name> | ||
| # Navigate to the newly cloned directory | ||
| cd <repo-name> | ||
| # Assign the original repo to a remote called "upstream" | ||
| git remote add upstream https://github.com/<upstream-owner>/<repo-name> | ||
| ``` | ||
|
|
||
| 2. If you cloned a while ago, get the latest changes from upstream: | ||
|
|
||
| ```bash | ||
| git checkout <dev-branch> | ||
| git pull upstream <dev-branch> | ||
| ``` | ||
|
|
||
| 3. Create a new topic branch (off the main project development branch) to | ||
| contain your feature, change, or fix: | ||
|
|
||
| ```bash | ||
| git checkout -b <topic-branch-name> | ||
| ``` | ||
|
|
||
| 4. Commit your changes in logical chunks. Please adhere to these [git commit | ||
| message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
| or your code is unlikely be merged into the main project. Use Git's | ||
| [interactive rebase](https://help.github.com/articles/interactive-rebase) | ||
| feature to tidy up your commits before making them public. | ||
| 5. Locally merge (or rebase) the upstream development branch into your topic branch: | ||
| ```bash | ||
| git pull [--rebase] upstream <dev-branch> | ||
| ``` | ||
| 6. Push your topic branch up to your fork: | ||
| ```bash | ||
| git push origin <topic-branch-name> | ||
| ``` | ||
| 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) | ||
| with a clear title and description. | ||
| **IMPORTANT**: By submitting a patch, you agree to allow the project owner to | ||
| license your work under the same license as that used by the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.