intel · Corsair-cxs · Mar 14, 2021 · Mar 14, 2021 · Mar 14, 2021
diff --git a/.github/BEFORE_YOU_START.md b/.github/BEFORE_YOU_START.md
@@ -0,0 +1,11 @@
+The issue list is reserved exclusively for bug reports and feature requests. That means we do not accept usage questions. If you open an issue that does not conform to the requirements, *it will be closed immediately.*
+Why are we so strict about this?
+
+For usage questions, please use the following resources:
+
+- Read the docs
+- Ask on the chat
+- Look for / ask questions on Stack Overflow
+
+
+Also try to search for your issue - it may have already been answered or even fixed in the development branch. However, if you find that an old, closed issue still persists in the latest version, you should open a new issue using the form below instead of commenting on the old issue.
diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md
@@ -0,0 +1,91 @@
+## Git Commit Message Convention
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+#### TL;DR:
+
+Messages must be matched by the following regex:
+
+``` js
+/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
+```
+
+#### Examples
+
+Appears under "Features" header, `compiler` subheader:
+
+```
+feat(compiler): add 'comments' option
+```
+
+Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:
+
+```
+fix(v-model): handle events on blur
+
+close #28
+```
+
+Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
+
+```
+perf(core): improve vdom diffing by removing 'foo' option
+
+BREAKING CHANGE: The 'foo' option has been removed.
+```
+
+The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
+
+```
+revert: feat(compiler): add 'comments' option
+
+This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
+```
+
+### Full Message Format
+
+A commit message consists of a **header**, **body** and **footer**.  The header has a **type**, **scope** and **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
+
+Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
+
+### Scope
+
+The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `transition` etc...
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize the first letter
+* no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,96 @@
+# Intel ros_openvino_toolkit Contributing Guide
+
+Hi! I'm really excited that you are interested in contributing to ros_openvino_toolkit. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
+
+- [Code of Conduct](https://github.com/intel/ros_openvino_toolkit/tree/dev-ov2020.3/.github/CODE_OF_CONDUCT.md)
+- [Issue Reporting Guidelines](#issue-reporting-guidelines)
+- [Pull Request Guidelines](#pull-request-guidelines)
+- [Development Setup](#development-setup)
+- [Project Structure](#project-structure)
+
+## Issue Reporting Guidelines
+
+- Always use [BEFORE_YOU_START.md](https://github.com/intel/ros_openvino_toolkit/tree/dev-ov2020.3/.github/BEFORE_YOU_START.md) to create new issues.
+- [Issue template](https://github.com/intel/ros_openvino_toolkit/tree/dev-ov2020.3/.github/ISSUE_TEMPLATE.md)
+
+## Pull Request Guidelines
+
+- The `master` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
+
+- Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch.
+
+- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.
+
+- If adding a new feature:
+  - Add accompanying test case.
+  - Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
+
+- If fixing bug:
+  - If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`.
+  - Provide a detailed description of the bug in the PR. Live demo preferred.
+  - Add appropriate test coverage if applicable.
+
+- [Pull Request template](https://github.com/intel/ros_openvino_toolkit/tree/dev-ov2020.3/.github/PULL_REQUEST_TEMPLATE.md)
+
+## Development Setup
+
+You will need [install openvino 2020.3](https://software.intel.com/content/www/us/en/develop/tools/openvino-toolkit.html) **version 2020.3.341**, [ROS Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu) .
+
+### install openvino 2020.3
+``` bash
+sudo apt update && sudo apt install curl gnupg2 lsb-release
+curl -s https://apt.repos.intel.com/openvino/2020/GPG-PUB-KEY-INTEL-OPENVINO-2020 |sudo apt-key add -
+echo "deb https://apt.repos.intel.com/openvino/2020 all main" | sudo tee /etc/apt/sources.list.d/intel-openvino-2020.list
+sudo apt update
+sudo apt-cache search openvino
+sudo apt-get install -y \
+  intel-openvino-runtime-ubuntu18-2020.3.341 \
+  intel-openvino-ie-samples-2020.3.341 \
+  intel-openvino-omz-dev-2020.3.341 \
+  intel-openvino-omz-tools-2020.3.341 \
+  intel-openvino-gstreamer-rt-ubuntu-bionic-2020.3.341 \
+  intel-openvino-gva-dev-ubuntu-bionic-2020.3.341 \
+  intel-openvino-gva-rt-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-bin-python-tools-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-core-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-cpu-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-gna-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-gpu-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-hddl-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-rt-vpu-ubuntu-bionic-2020.3.341 \
+  intel-openvino-ie-sdk-ubuntu-bionic-2020.3.341 \
+  intel-openvino-opencv-lib-ubuntu-bionic-2020.3.341
+sudo apt-get install -y libgflags-dev
+ls -lh /opt/intel/openvino
+source /opt/intel/openvino/bin/setupvars.sh
+```
+
+### build ros openvino toolkit
+```bash
+mkdir -p ~/catkin_ws/src
+cp -rf ${GITHUB_WORKSPACE} ~/catkin_ws/src
+cd ~/catkin_ws/src
+git clone https://github.com/intel/object_msgs.git
+cd ~/catkin_ws/
+source /opt/ros/melodic/setup.bash
+source /opt/intel/openvino/bin/setupvars.sh
+export CPU_EXTENSION_LIB+=/opt/intel/openvino_2020.3.341/deployment_tools/inference_engine/lib/intel64/libinference_engine.so
+export GFLAGS_LIB+=/usr/lib/x86_64-linux-gnu/libgflags_nothreads.a
+env
+catkin_make
+```
+
+### Committing Changes
+
+Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit. If you are not familiar with the commit message convention, you can use `npm run commit` instead of `git commit`, which provides an interactive CLI for generating proper commit messages.
+
+
+## Project Structure
+
+- TODO
+
+## Credits
+
+Thank you to all the people who have already contributed to ros_openvino_toolkit!
+
+<a href="https://github.com/intel/ros_openvino_toolkit/graphs/contributors">
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,20 @@
+## 1. Bug reports
+
+**Version** 
+> - ROS: `Melodic `
+> - OpenVION: `2020.3.341`
+> - ros_openvino_toolkit: `dev-ov2020.3 `
+
+**Reproduction link**
+> https://github.com/intel/ros_openvino_toolkit/blob/dev-ov2020.3/xxx (The related files...)
+
+**Steps to reproduce**
+> (Record how you find the bug)
+
+**What is expected?**
+> (Expected results)
+
+**What is actually happening?**
+> (Error details. For example console reports, screenshots, etc...)
+
+---
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,34 @@
+<!--
+Please make sure to read the Pull Request Guidelines:
+https://github.com/intel/ros_openvino_toolkit/blob/dev-ov2020.3/.github/CONTRIBUTING.md#pull-request-guidelines
+-->
+<!-- PULL REQUEST TEMPLATE -->
+<!-- (Update "[ ]" to "[x]" to check a box) -->
+
+**What kind of change does this PR introduce?** (check at least one)
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update
+- [ ] Refactor
+- [ ] Build-related changes
+- [ ] Other, please describe:
+
+**Does this PR introduce a breaking change?** (check one)
+
+- [ ] Yes
+- [ ] No
+
+If yes, please describe the impact and migration path for existing applications:
+
+**The PR fulfills these requirements:**
+
+- [ ] It's submitted to the `dev` branch for ros_openvino_toolkit (or to a previous version branch), _not_ the `master` branch
+- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
+- [ ] All tests are passing: https://github.com/intel/ros_openvino_toolkit/blob/dev-ov2020.3/.github/CONTRIBUTING.md#development-setup
+- [ ] New/updated tests are included
+
+If adding a **new feature**, the PR's description includes:
+- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
+
+**Other information:**