Update GitHub issues templates (#5404)
Browse files* Update GitHub issues templates
* pre-commit fixes
Co-authored-by: pre-commit <[email protected]>
- .github/ISSUE_TEMPLATE/bug-report.md +0 -59
- .github/ISSUE_TEMPLATE/bug-report.yml +83 -0
- .github/ISSUE_TEMPLATE/config.yml +8 -0
- .github/ISSUE_TEMPLATE/feature-request.md +0 -29
- .github/ISSUE_TEMPLATE/feature-request.yml +50 -0
- .github/ISSUE_TEMPLATE/question.md +0 -12
- .github/ISSUE_TEMPLATE/question.yml +33 -0
.github/ISSUE_TEMPLATE/bug-report.md
DELETED
@@ -1,59 +0,0 @@
|
|
1 |
-
---
|
2 |
-
name: "🐛 Bug report"
|
3 |
-
about: Create a report to help us improve
|
4 |
-
title: ''
|
5 |
-
labels: bug
|
6 |
-
assignees: ''
|
7 |
-
|
8 |
-
---
|
9 |
-
|
10 |
-
Before submitting a bug report, please be aware that your issue **must be reproducible** with all of the following,
|
11 |
-
otherwise it is non-actionable, and we can not help you:
|
12 |
-
|
13 |
-
- **Current repo**: run `git fetch && git status -uno` to check and `git pull` to update repo
|
14 |
-
- **Common dataset**: coco.yaml or coco128.yaml
|
15 |
-
- **Common environment**: Colab, Google Cloud, or Docker image. See https://github.com/ultralytics/yolov5#environments
|
16 |
-
|
17 |
-
If this is a custom dataset/training question you **must include** your `train*.jpg`, `val*.jpg` and `results.png`
|
18 |
-
figures, or we can not help you. You can generate these with `utils.plot_results()`.
|
19 |
-
|
20 |
-
## 🐛 Bug
|
21 |
-
|
22 |
-
A clear and concise description of what the bug is.
|
23 |
-
|
24 |
-
## To Reproduce (REQUIRED)
|
25 |
-
|
26 |
-
Input:
|
27 |
-
|
28 |
-
```
|
29 |
-
import torch
|
30 |
-
|
31 |
-
a = torch.tensor([5])
|
32 |
-
c = a / 0
|
33 |
-
```
|
34 |
-
|
35 |
-
Output:
|
36 |
-
|
37 |
-
```
|
38 |
-
Traceback (most recent call last):
|
39 |
-
File "/Users/glennjocher/opt/anaconda3/envs/env1/lib/python3.7/site-packages/IPython/core/interactiveshell.py", line 3331, in run_code
|
40 |
-
exec(code_obj, self.user_global_ns, self.user_ns)
|
41 |
-
File "<ipython-input-5-be04c762b799>", line 5, in <module>
|
42 |
-
c = a / 0
|
43 |
-
RuntimeError: ZeroDivisionError
|
44 |
-
```
|
45 |
-
|
46 |
-
## Expected behavior
|
47 |
-
|
48 |
-
A clear and concise description of what you expected to happen.
|
49 |
-
|
50 |
-
## Environment
|
51 |
-
|
52 |
-
If applicable, add screenshots to help explain your problem.
|
53 |
-
|
54 |
-
- OS: [e.g. Ubuntu]
|
55 |
-
- GPU [e.g. 2080 Ti]
|
56 |
-
|
57 |
-
## Additional context
|
58 |
-
|
59 |
-
Add any other context about the problem here.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.github/ISSUE_TEMPLATE/bug-report.yml
ADDED
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: 🐛 Bug Report
|
2 |
+
# title: " "
|
3 |
+
description: Problems with YOLOv5
|
4 |
+
labels: [bug, triage]
|
5 |
+
body:
|
6 |
+
- type: markdown
|
7 |
+
attributes:
|
8 |
+
value: |
|
9 |
+
Thank you for submitting a YOLOv5 🐛 Bug Report!
|
10 |
+
|
11 |
+
- type: checkboxes
|
12 |
+
attributes:
|
13 |
+
label: Search before asking
|
14 |
+
description: >
|
15 |
+
Please search the [issues](https://github.com/ultralytics/yolov5/issues) to see if a similar bug report already exists.
|
16 |
+
options:
|
17 |
+
- label: >
|
18 |
+
I have searched the YOLOv5 [issues](https://github.com/ultralytics/yolov5/issues) and found no similar bug report.
|
19 |
+
required: true
|
20 |
+
|
21 |
+
- type: dropdown
|
22 |
+
attributes:
|
23 |
+
label: YOLOv5 Component
|
24 |
+
description: |
|
25 |
+
Please select the part of YOLOv5 where you found the bug.
|
26 |
+
multiple: true
|
27 |
+
options:
|
28 |
+
- "Training"
|
29 |
+
- "Validation"
|
30 |
+
- "Detection"
|
31 |
+
- "Export"
|
32 |
+
- "PyTorch Hub"
|
33 |
+
- "Multi-GPU"
|
34 |
+
- "Evolution"
|
35 |
+
- "Integrations"
|
36 |
+
- "Other"
|
37 |
+
validations:
|
38 |
+
required: false
|
39 |
+
|
40 |
+
- type: textarea
|
41 |
+
attributes:
|
42 |
+
label: Bug
|
43 |
+
description: Provide console output with error messages and/or screenshots of the bug.
|
44 |
+
placeholder: >
|
45 |
+
TIP: Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response.
|
46 |
+
validations:
|
47 |
+
required: true
|
48 |
+
|
49 |
+
- type: textarea
|
50 |
+
attributes:
|
51 |
+
label: Environment
|
52 |
+
description: Please specify the software and hardware you used to produce the bug.
|
53 |
+
placeholder: |
|
54 |
+
- YOLO: YOLOv5 🚀 v6.0-37-g620b535 torch 1.9.0+cu111 CUDA:0 (Tesla V100-SXM2-16GB, 16160.5MB)
|
55 |
+
- OS: Ubuntu 20.04
|
56 |
+
- Python: 3.9.0
|
57 |
+
validations:
|
58 |
+
required: false
|
59 |
+
|
60 |
+
- type: textarea
|
61 |
+
attributes:
|
62 |
+
label: Minimal Reproducible Example
|
63 |
+
description: >
|
64 |
+
When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem.
|
65 |
+
This is referred to by community members as creating a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
|
66 |
+
placeholder: |
|
67 |
+
# code to reproduce your issue here
|
68 |
+
validations:
|
69 |
+
required: false
|
70 |
+
|
71 |
+
- type: textarea
|
72 |
+
attributes:
|
73 |
+
label: Additional
|
74 |
+
description: Anything else you would like to share?
|
75 |
+
|
76 |
+
- type: checkboxes
|
77 |
+
attributes:
|
78 |
+
label: Are you willing to submit a PR?
|
79 |
+
description: >
|
80 |
+
(Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/yolov5/pulls) (PR) to help improve YOLOv5 for everyone, especially if you have a good understanding of how to implement a fix or feature.
|
81 |
+
See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started.
|
82 |
+
options:
|
83 |
+
- label: Yes I'd like to help by submitting a PR!
|
.github/ISSUE_TEMPLATE/config.yml
ADDED
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
blank_issues_enabled: true
|
2 |
+
contact_links:
|
3 |
+
- name: Slack
|
4 |
+
url: https://join.slack.com/t/ultralytics/shared_invite/zt-w29ei8bp-jczz7QYUmDtgo6r6KcMIAg
|
5 |
+
about: Ask on Ultralytics Slack Forum
|
6 |
+
- name: Stack Overflow
|
7 |
+
url: https://stackoverflow.com/search?q=YOLOv5
|
8 |
+
about: Ask on Stack Overflow with 'YOLOv5' tag
|
.github/ISSUE_TEMPLATE/feature-request.md
DELETED
@@ -1,29 +0,0 @@
|
|
1 |
-
---
|
2 |
-
name: "🚀 Feature request"
|
3 |
-
about: Suggest an idea for this project
|
4 |
-
title: ''
|
5 |
-
labels: enhancement
|
6 |
-
assignees: ''
|
7 |
-
|
8 |
-
---
|
9 |
-
|
10 |
-
## 🚀 Feature
|
11 |
-
|
12 |
-
<!-- A clear and concise description of the feature proposal -->
|
13 |
-
|
14 |
-
## Motivation
|
15 |
-
|
16 |
-
<!-- Please outline the motivation for the proposal. Is your feature request related to a problem?
|
17 |
-
e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
|
18 |
-
|
19 |
-
## Pitch
|
20 |
-
|
21 |
-
<!-- A clear and concise description of what you want to happen. -->
|
22 |
-
|
23 |
-
## Alternatives
|
24 |
-
|
25 |
-
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
|
26 |
-
|
27 |
-
## Additional context
|
28 |
-
|
29 |
-
<!-- Add any other context or screenshots about the feature request here. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.github/ISSUE_TEMPLATE/feature-request.yml
ADDED
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: 🚀 Feature Request
|
2 |
+
description: Suggest a YOLOv5 idea
|
3 |
+
# title: " "
|
4 |
+
labels: [enhancement]
|
5 |
+
body:
|
6 |
+
- type: markdown
|
7 |
+
attributes:
|
8 |
+
value: |
|
9 |
+
Thank you for submitting a YOLOv5 🚀 Feature Request!
|
10 |
+
|
11 |
+
- type: checkboxes
|
12 |
+
attributes:
|
13 |
+
label: Search before asking
|
14 |
+
description: >
|
15 |
+
Please search the [issues](https://github.com/ultralytics/yolov5/issues) to see if a similar feature request already exists.
|
16 |
+
options:
|
17 |
+
- label: >
|
18 |
+
I have searched the YOLOv5 [issues](https://github.com/ultralytics/yolov5/issues) and found no similar feature requests.
|
19 |
+
required: true
|
20 |
+
|
21 |
+
- type: textarea
|
22 |
+
attributes:
|
23 |
+
label: Description
|
24 |
+
description: A short description of your feature.
|
25 |
+
placeholder: |
|
26 |
+
What new feature would you like to see in YOLOv5?
|
27 |
+
validations:
|
28 |
+
required: true
|
29 |
+
|
30 |
+
- type: textarea
|
31 |
+
attributes:
|
32 |
+
label: Use case
|
33 |
+
description: |
|
34 |
+
Describe the use case of your feature request. It will help us understand and prioritize the feature request.
|
35 |
+
placeholder: |
|
36 |
+
How would this feature be used, and who would use it?
|
37 |
+
|
38 |
+
- type: textarea
|
39 |
+
attributes:
|
40 |
+
label: Additional
|
41 |
+
description: Anything else you would like to share?
|
42 |
+
|
43 |
+
- type: checkboxes
|
44 |
+
attributes:
|
45 |
+
label: Are you willing to submit a PR?
|
46 |
+
description: >
|
47 |
+
(Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/yolov5/pulls) (PR) to help improve YOLOv5 for everyone, especially if you have a good understanding of how to implement a fix or feature.
|
48 |
+
See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started.
|
49 |
+
options:
|
50 |
+
- label: Yes I'd like to help by submitting a PR!
|
.github/ISSUE_TEMPLATE/question.md
DELETED
@@ -1,12 +0,0 @@
|
|
1 |
-
---
|
2 |
-
name: "❓Question"
|
3 |
-
about: Ask a general question
|
4 |
-
title: ''
|
5 |
-
labels: question
|
6 |
-
assignees: ''
|
7 |
-
|
8 |
-
---
|
9 |
-
|
10 |
-
## ❔Question
|
11 |
-
|
12 |
-
## Additional context
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.github/ISSUE_TEMPLATE/question.yml
ADDED
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
name: ❓ Question
|
2 |
+
description: Ask a YOLOv5 question
|
3 |
+
# title: " "
|
4 |
+
labels: [question]
|
5 |
+
body:
|
6 |
+
- type: markdown
|
7 |
+
attributes:
|
8 |
+
value: |
|
9 |
+
Thank you for asking a YOLOv5 ❓ Question!
|
10 |
+
|
11 |
+
- type: checkboxes
|
12 |
+
attributes:
|
13 |
+
label: Search before asking
|
14 |
+
description: >
|
15 |
+
Please search the [issues](https://github.com/ultralytics/yolov5/issues) and [discussions](https://github.com/ultralytics/yolov5/discussions) to see if a similar question already exists.
|
16 |
+
options:
|
17 |
+
- label: >
|
18 |
+
I have searched the YOLOv5 [issues](https://github.com/ultralytics/yolov5/issues) and [discussions](https://github.com/ultralytics/yolov5/discussions) and found no similar questions.
|
19 |
+
required: true
|
20 |
+
|
21 |
+
- type: textarea
|
22 |
+
attributes:
|
23 |
+
label: Question
|
24 |
+
description: What is your question?
|
25 |
+
placeholder: >
|
26 |
+
TIP: Include as much information as possible (screenshots, links, reference etc.) to receive the most helpful response.
|
27 |
+
validations:
|
28 |
+
required: true
|
29 |
+
|
30 |
+
- type: textarea
|
31 |
+
attributes:
|
32 |
+
label: Additional
|
33 |
+
description: Anything else you would like to share?
|