Update documentation

.github/pull_request_template.md

@@ -0,0 +1,50 @@
+<!---
+Copyright (C) 2020 Intel Corporation
+
+SPDX-License-Identifier: MIT
+-->
+
+<!-- Check contributing guide here:
+https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md
+-->
+
+### Summary
+<!--
+Resolves #111 and #222.
+Depends on #1000 (for series of dependent commits).
+
+This PR introduces this capability and deprecates that functionality
+to make the project better in this and that area.
+
+- Added this feature
+- Removed that feature
+- Fixed the problem #1234
+-->
+
+### How to test
+<!-- Describe the testing procedure for reviewers, if changes are
+not fully covered by unit tests or manual testing can be complicated.
+-->
+
+### Checklist
+<!-- Put an 'x' in all the boxes that apply -->
+- [ ] I submit my changes into the `develop` branch
+- [ ] I have added description of my changes into [CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md)
+- [ ] I have updated the [documentation](
+  https://github.com/openvinotoolkit/datumaro/tree/develop/docs) accordingly
+- [ ] I have added tests to cover my changes
+- [ ] I have [linked related issues](
+  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))
+
+### 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.
+- [ ] I have updated the license header for each file (see an example below)
+
+```python
+# Copyright (C) 2020 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+```

CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release
+
+## Template
+```
+## [Unreleased]
+### Added
+-
+
+### Changed
+-
+
+### Deprecated
+-
+
+### Removed
+-
+
+### Fixed
+-
+
+### Security
+-
+```

CONTRIBUTING.md

@@ -10,13 +10,12 @@
 ### Prerequisites
 
 - Python (3.5+)
-- OpenVINO (optional)
 
 ``` bash
-git clone https://github.com/opencv/cvat
+git clone https://github.com/openvinotoolkit/datumaro
 ```
 
-Optionally, install a virtual environment:
+Optionally, install a virtual environment (recommended):
 
 ``` bash
 python -m pip install virtualenv
@@ -30,16 +29,29 @@ Then install all dependencies:
 while read -r p; do pip install $p; done < requirements.txt
 ```
 
-If you're working inside CVAT environment:
+If you're working inside of a CVAT environment:
 ``` bash
 . .env/bin/activate
 while read -r p; do pip install $p; done < datumaro/requirements.txt
 ```
 
-## Usage
+Install Datumaro:
+``` bash
+pip install -e /path/to/the/cloned/repo/
+```
 
-> The directory containing Datumaro should be in the `PYTHONPATH`
-> environment variable or `cvat/datumaro/` should be the current directory.
+**Optional dependencies**
+
+These components are only required for plugins and not installed by default:
+
+- OpenVINO
+- Accuracy Checker
+- TensorFlow
+- PyTorch
+- MxNet
+- Caffe
+
+## Usage
 
 ``` bash
 datum --help
@@ -63,7 +75,7 @@ To run tests use:
 python -m unittest discover -s tests
 ```
 
-If you're working inside CVAT environment, you can also use:
+If you're working inside of a CVAT environment, you can also use:
 
 ``` bash
 python manage.py test datumaro/
@@ -72,4 +84,16 @@ python manage.py test datumaro/
 ## Design and code structure
 
 - [Design document](docs/design.md)
-- [Developer guide](docs/developer_guide.md)
+- [Developer guide](docs/developer_guide.md)
+
+## Code style
+
+Try to be readable and consistent with the existing codebase.
+The project mostly follows PEP8 with little differences.
+Continuation lines have a standard indentation step by default,
+or any other, if it improves readability. For long conditionals use 2 steps.
+No trailing whitespaces, 80 characters per line.
+
+## Environment
+
+The recommended editor is VS Code with the Python plugin.