Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed .github/.gitkeep
Empty file.
17 changes: 17 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#cpp code owners
cpp/ @<org>/<repo>-cpp-codeowners

#python code owners
python/ @<org>/<repo>-python-codeowners

#cmake code owners
**/CMakeLists.txt @<org>/<repo>-cmake-codeowners
**/cmake/ @<org>/<repo>-cmake-codeowners

#build/ops code owners
.github/ @<org>/ops-codeowners
ci/ @<org>/ops-codeowners
conda/ @<org>/ops-codeowners
**/Dockerfile @<org>/ops-codeowners
**/.dockerignore @<org>/ops-codeowners
docker/ @<org>/ops-codeowners
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a bug report to help us improve DeepStream
title: "[BUG]"
labels: "? - Needs Triage, bug"
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**Steps/Code to reproduce bug**
Follow [this guide](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) to craft a minimal bug report. This helps us reproduce the issue you're having and resolve the issue more quickly.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment details (please complete the following information):**
- Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
- Method of DeepStream install: [conda, Docker, pip, or from source]
- If method of install is [Docker], provide `docker pull` & `docker run` commands used
- Run `print_env.sh` from the project root and paste the results here


**Additional context**
Add any other context about the problem here.

-----
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Bug Report
description: File a bug report
title: "[BUG]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!

- type: input
id: version
attributes:
label: Version
description: What version of DeepStream are you running?
placeholder: "example: 23.02"
validations:
required: true

- type: dropdown
id: installation-method
attributes:
label: Which installation method(s) does this occur on?
multiple: true
options:
- Docker
- Conda
- Pip
- Source

- type: textarea
id: description
attributes:
label: Describe the bug.
description: Also tell us, what did you expect to happen?
placeholder: XYZ occured, I expected QRS results
validations:
required: true

- type: textarea
id: mvr
attributes:
label: Minimum reproducible example
description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here
render: shell

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please paste relevant error and log output here
render: shell

- type: textarea
id: env-printout
attributes:
label: Full env printout
description: Please run and paste the output of the `print_env.sh` script here, to gather any other relevant environment details
render: shell

- type: textarea
id: misc
attributes:
label: Other/Misc.
description: Please enter any other helpful information here.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
options:
- label: I agree to follow __THIS PROJECT__'s Code of Conduct
required: true
- label: I have searched the [open bugs](https://github.com/jarmak-nv/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GitHub info on config.yml
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
# Set to 'false' if you only want the templates to be used.
blank_issues_enabled: true

# When using discussions instead of Question issue templates,
# link that below to have it show up in the 'Submit Issue' page
contact_links:
- name: Ask a Question
url: https://github.com/jarmak-nv/rapids-repo-template/discussions
about: Please ask any questions here.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Documentation request
about: Report incorrect or needed documentation
title: "[DOC]"
labels: "? - Needs Triage, doc"
assignees: ''

---


<!-- Fill out either incorrect documentation, or needed documentation and delete the unused section -->

## Report incorrect documentation

**Location of incorrect documentation**
Provide links and line numbers if applicable.

**Describe the problems or issues found in the documentation**
A clear and concise description of what you found to be incorrect.

**Steps taken to verify documentation is incorrect**
List any steps you have taken:

**Suggested fix for documentation**
Detail proposed changes to fix the documentation if you have any.

---

## Report needed documentation

**Report needed documentation**
A clear and concise description of what documentation you believe it is needed and why.

**Describe the documentation you'd like**
A clear and concise description of what you want to happen.

**Steps taken to search for needed documentation**
List any steps you have taken:


-----
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_correction.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Documentation - Correction/Update Request
description: Request corrections or updates to existing documentation
title: "[DOC]: "
labels: ["doc"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve our documentation!

- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this documentation request
options:
- Critical (currently preventing usage)
- High
- Medium
- Low (would be nice)
validations:
required: true

- type: input
id: correction_location
attributes:
label: Please provide a link or source to the relevant docs
placeholder: "ex: https://github.com/jarmak-nv/rapids-repo-template/blob/main/README.md"
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the problems in the documentation
placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
validations:
required: true

- type: textarea
id: correction
attributes:
label: (Optional) Propose a correction
placeholder: foo.func() was deprecated, replace documentation with foo.new_func()

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow DeepStream's Code of Conduct
required: true
- label: I have searched the [open documentation issues](https://github.com/jarmak-nv/rapids-repo-template/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
required: true
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_new.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Documentation - New Documentation Request
description: Request additions to DeepStream documentation
title: "[DOC]: "
labels: ["doc"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve our documentation!

- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this documentation request
options:
- Critical (currently preventing usage)
- High
- Medium
- Low (would be nice)
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the future/missing documentation
placeholder: A code snippet mentions function foo(args) but I cannot find any documentation on it.
validations:
required: true

- type: textarea
id: search_locs
attributes:
label: Where have you looked?
placeholder: |
https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template/blob/main/README.md

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NVIDIA-GitHub-Management/PLC-OSS-Template/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow DeepStream's Code of Conduct
required: true
- label: I have searched the project's documentation and have found no duplicates for this bug report
required: true
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for DeepStream
title: "[FEA]"
labels: "? - Needs Triage, feature request"
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I wish I could use DeepStream to do [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context, code examples, or references to existing implementations about the feature request here.

-----
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).
Loading