forked from openvinotoolkit/nncf
-
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.
Issue templates (openvinotoolkit#2519)
### Changes Added issue templates ### Reason for changes Introduce GFI in NNCF ### Related tickets N/A ### Tests You can test what the templates will look like: https://github.com/alexsu52/nncf/issues
- Loading branch information
Showing
5 changed files
with
161 additions
and
3 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
name: 🐛 Bug Report | ||
description: Help us improve NNCF. | ||
labels: ["bug"] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: 🐛 Describe the bug | ||
description: Please provide a clear and concise description of the bug, as well console output with error messages and/or screenshots. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: Please specify the software and hardware you used to produce the bug. | ||
placeholder: | | ||
Provide python environment using command: | ||
Attach the `requirements.txt` file that is generated by `pip freeze > requirements.txt` | ||
Manually: | ||
Provide the NNCF version and OpenVINO, Torch, TensorFlow, ONNX versions if applicable. | ||
Additionally: | ||
OS Ubuntu 20.04.5 LTS | ||
Python 3.10.0 | ||
Install git | ||
RAM 32.00 GB | ||
CPU Intel(R) Core(TM) i9-10980XE CPU @ 3.00GHz | ||
CUDA None | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Minimal Reproducible Example | ||
description: | | ||
How can we reproduce your issue? | ||
The minimal code snippet that is easy to understand and can be used to reproduce the issue is the best explanation of the issue! | ||
placeholder: | | ||
``` | ||
# Code to reproduce your issue here | ||
``` | ||
validations: | ||
required: false | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Are you going to submit a PR? | ||
description: > | ||
(Optional) We'd love your help! If you have a good understanding of how to implement a fix or feature, you can submit a [Pull Request](https://github.com/openvinotoolkit/nncf/pulls) (PR). | ||
See the NNCF [Contributing Guide](https://github.com/openvinotoolkit/nncf/blob/develop/CONTRIBUTING.md) to get started. | ||
options: | ||
- label: Yes I'd like to help by submitting a PR! | ||
|
||
- type: markdown | ||
attributes: | ||
value: > | ||
Thanks for contributing 🎉! |
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: ❓ Questions | ||
url: https://github.com/openvinotoolkit/nncf/discussions | ||
about: Ask questions and discuss with other NNCF community members |
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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: 🚀 Feature request | ||
description: Submit a proposal/request for a new NNCF feature | ||
labels: ["enhancement"] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: 🚀 Feature request | ||
description: > | ||
A clear and concise description of the feature proposal. Please provide a link to the paper and code in case they exist. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Feature Use Case | ||
description: What is the use case of the feature you are proposing? | ||
placeholder: What is the new feature use case? How will it be useful? | ||
validations: | ||
required: false | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Are you going to submit a PR? | ||
description: > | ||
(Optional) We'd love your help! If you have a good understanding of how to implement a fix or feature, you can submit a [Pull Request](https://github.com/openvinotoolkit/nncf/pulls) (PR). | ||
See the NNCF [Contributing Guide](https://github.com/openvinotoolkit/nncf/blob/develop/CONTRIBUTING.md) to get started. | ||
options: | ||
- label: Yes I'd like to help by submitting a PR! | ||
|
||
- type: markdown | ||
attributes: | ||
value: > | ||
Thanks for contributing 🎉! |
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 |
---|---|---|
@@ -0,0 +1,65 @@ | ||
name: 🤩 Good First Issue | ||
description: Create a Good First Issue for new contributors. | ||
title: "[Good First Issue][NNCF]: " | ||
labels: ["good first issue"] | ||
body: | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Context | ||
description: | | ||
Let the contributors know what your component is responsible for, | ||
what's the importance of the change and why it's needed. | ||
Keep in mind the Good First Issue is for new contributors. | ||
placeholder: What is it and why is it important? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: todo_list | ||
attributes: | ||
label: What needs to be done? | ||
description: | | ||
Be as verbose as possible, provide a TODO list if viable. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: example_prs | ||
attributes: | ||
label: Example Pull Requests | ||
description: | | ||
Provide example Pull requests, if there are any. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: resources | ||
attributes: | ||
label: Resources | ||
description: | | ||
Any materials related to the task, such as operator specifications, | ||
discussions, guides. | ||
value: | | ||
- [Contribution guide - start here!](https://github.com/openvinotoolkit/nncf/blob/develop/CONTRIBUTING.md) | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: contact_points | ||
attributes: | ||
label: Contact points | ||
description: | | ||
People who can be asked questions about the task. | ||
placeholder: GitHub users | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: ticket | ||
attributes: | ||
label: Ticket | ||
description: | | ||
Provide the ticket number, if available. | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.