diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..8a93f685 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: "[BUG_TITLE]" +labels: bug +assignees: '' + +--- + +# [BUG_TITLE] + +## Description + +A clear and concise description of what the bug is. + +## Expected behavior + +A clear and concise description of what you expected to happen. +If applicable, add screenshots or code snippets to help explain your problem. + +## Environment + - OS: [_e.g._ `iOS`] + - Python version: [_e.g._ `3.8`] + - Package version: [_e.g._ `0.0.1`] + +## To Reproduce + +Please provide a minimal reproducible example. + +## Additional context + +If applicable, add any other context about the problem here. diff --git a/README.md b/README.md index 194b0d84..4f6a85f3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ [![Docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + This library includes a collection of helper functions and utilities for the Luxonis MLOps stack. This includes the following submodules: - **Dataset Management**: Creating computer vision datasets focused around Luxonis hardware and loading data into our training library. @@ -48,4 +49,4 @@ pip install luxonis-ml[all] ## Contributing -If you want to contribute to this project, read the instructions in [CONTRIBUTING.md](CONTRIBUTING.md) +If you want to contribute to this project, read the instructions in [CONTRIBUTING.md](https://github.com/luxonis/luxonis-ml/blob/main/CONTRIBUTING.md)