Browse Source
Update GitHub issues templates (#5404)
* Update GitHub issues templates * pre-commit fixes Co-authored-by: pre-commit <pre-commit@example.com>modifyDataloader
Glenn Jocher
GitHub
3 years ago
7 changed files with 174 additions and 100 deletions
+ 0
- 59
.github/ISSUE_TEMPLATE/bug-report.md
View File
| --- | |||||
| name: "🐛 Bug report" | |||||
| about: Create a report to help us improve | |||||
| title: '' | |||||
| labels: bug | |||||
| assignees: '' | |||||
| --- | |||||
| Before submitting a bug report, please be aware that your issue **must be reproducible** with all of the following, | |||||
| otherwise it is non-actionable, and we can not help you: | |||||
| - **Current repo**: run `git fetch && git status -uno` to check and `git pull` to update repo | |||||
| - **Common dataset**: coco.yaml or coco128.yaml | |||||
| - **Common environment**: Colab, Google Cloud, or Docker image. See https://github.com/ultralytics/yolov5#environments | |||||
| If this is a custom dataset/training question you **must include** your `train*.jpg`, `val*.jpg` and `results.png` | |||||
| figures, or we can not help you. You can generate these with `utils.plot_results()`. | |||||
| ## 🐛 Bug | |||||
| A clear and concise description of what the bug is. | |||||
| ## To Reproduce (REQUIRED) | |||||
| Input: | |||||
| ``` | |||||
| import torch | |||||
| a = torch.tensor([5]) | |||||
| c = a / 0 | |||||
| ``` | |||||
| Output: | |||||
| ``` | |||||
| Traceback (most recent call last): | |||||
| File "/Users/glennjocher/opt/anaconda3/envs/env1/lib/python3.7/site-packages/IPython/core/interactiveshell.py", line 3331, in run_code | |||||
| exec(code_obj, self.user_global_ns, self.user_ns) | |||||
| File "<ipython-input-5-be04c762b799>", line 5, in <module> | |||||
| c = a / 0 | |||||
| RuntimeError: ZeroDivisionError | |||||
| ``` | |||||
| ## Expected behavior | |||||
| A clear and concise description of what you expected to happen. | |||||
| ## Environment | |||||
| If applicable, add screenshots to help explain your problem. | |||||
| - OS: [e.g. Ubuntu] | |||||
| - GPU [e.g. 2080 Ti] | |||||
| ## Additional context | |||||
| Add any other context about the problem here. |
+ 83
- 0
.github/ISSUE_TEMPLATE/bug-report.yml
View File
| name: 🐛 Bug Report | |||||
| # title: " " | |||||
| description: Problems with YOLOv5 | |||||
| labels: [bug, triage] | |||||
| body: | |||||
| - type: markdown | |||||
| attributes: | |||||
| value: | | |||||
| Thank you for submitting a YOLOv5 🐛 Bug Report! | |||||
| - type: checkboxes | |||||
| attributes: | |||||
| label: Search before asking | |||||
| description: > | |||||
| Please search the [issues](https://github.com/ultralytics/yolov5/issues) to see if a similar bug report already exists. | |||||
| options: | |||||
| - label: > | |||||
| I have searched the YOLOv5 [issues](https://github.com/ultralytics/yolov5/issues) and found no similar bug report. | |||||
| required: true | |||||
| - type: dropdown | |||||
| attributes: | |||||
| label: YOLOv5 Component | |||||
| description: | | |||||
| Please select the part of YOLOv5 where you found the bug. | |||||
| multiple: true | |||||
| options: | |||||
| - "Training" | |||||
| - "Validation" | |||||
| - "Detection" | |||||
| - "Export" | |||||
| - "PyTorch Hub" | |||||
| - "Multi-GPU" | |||||
| - "Evolution" | |||||
| - "Integrations" | |||||
| - "Other" | |||||
| validations: | |||||
| required: false | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Bug | |||||
| description: Provide console output with error messages and/or screenshots of the bug. | |||||
| placeholder: > | |||||
| TIP: Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response. | |||||
| validations: | |||||
| required: true | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Environment | |||||
| description: Please specify the software and hardware you used to produce the bug. | |||||
| placeholder: | | |||||
| - YOLO: YOLOv5 🚀 v6.0-37-g620b535 torch 1.9.0+cu111 CUDA:0 (Tesla V100-SXM2-16GB, 16160.5MB) | |||||
| - OS: Ubuntu 20.04 | |||||
| - Python: 3.9.0 | |||||
| validations: | |||||
| required: false | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Minimal Reproducible Example | |||||
| description: > | |||||
| 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. | |||||
| This is referred to by community members as creating a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). | |||||
| placeholder: | | |||||
| # code to reproduce your issue here | |||||
| validations: | |||||
| required: false | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Additional | |||||
| description: Anything else you would like to share? | |||||
| - type: checkboxes | |||||
| attributes: | |||||
| label: Are you willing to submit a PR? | |||||
| description: > | |||||
| (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. | |||||
| See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started. | |||||
| options: | |||||
| - label: Yes I'd like to help by submitting a PR! |
+ 8
- 0
.github/ISSUE_TEMPLATE/config.yml
View File
| blank_issues_enabled: true | |||||
| contact_links: | |||||
| - name: Slack | |||||
| url: https://join.slack.com/t/ultralytics/shared_invite/zt-w29ei8bp-jczz7QYUmDtgo6r6KcMIAg | |||||
| about: Ask on Ultralytics Slack Forum | |||||
| - name: Stack Overflow | |||||
| url: https://stackoverflow.com/search?q=YOLOv5 | |||||
| about: Ask on Stack Overflow with 'YOLOv5' tag |
+ 0
- 29
.github/ISSUE_TEMPLATE/feature-request.md
View File
| --- | |||||
| name: "🚀 Feature request" | |||||
| about: Suggest an idea for this project | |||||
| title: '' | |||||
| labels: enhancement | |||||
| assignees: '' | |||||
| --- | |||||
| ## 🚀 Feature | |||||
| <!-- A clear and concise description of the feature proposal --> | |||||
| ## Motivation | |||||
| <!-- Please outline the motivation for the proposal. Is your feature request related to a problem? | |||||
| e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too --> | |||||
| ## Pitch | |||||
| <!-- A clear and concise description of what you want to happen. --> | |||||
| ## Alternatives | |||||
| <!-- A clear and concise description of any alternative solutions or features you've considered, if any. --> | |||||
| ## Additional context | |||||
| <!-- Add any other context or screenshots about the feature request here. --> |
+ 50
- 0
.github/ISSUE_TEMPLATE/feature-request.yml
View File
| name: 🚀 Feature Request | |||||
| description: Suggest a YOLOv5 idea | |||||
| # title: " " | |||||
| labels: [enhancement] | |||||
| body: | |||||
| - type: markdown | |||||
| attributes: | |||||
| value: | | |||||
| Thank you for submitting a YOLOv5 🚀 Feature Request! | |||||
| - type: checkboxes | |||||
| attributes: | |||||
| label: Search before asking | |||||
| description: > | |||||
| Please search the [issues](https://github.com/ultralytics/yolov5/issues) to see if a similar feature request already exists. | |||||
| options: | |||||
| - label: > | |||||
| I have searched the YOLOv5 [issues](https://github.com/ultralytics/yolov5/issues) and found no similar feature requests. | |||||
| required: true | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Description | |||||
| description: A short description of your feature. | |||||
| placeholder: | | |||||
| What new feature would you like to see in YOLOv5? | |||||
| validations: | |||||
| required: true | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Use case | |||||
| description: | | |||||
| Describe the use case of your feature request. It will help us understand and prioritize the feature request. | |||||
| placeholder: | | |||||
| How would this feature be used, and who would use it? | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Additional | |||||
| description: Anything else you would like to share? | |||||
| - type: checkboxes | |||||
| attributes: | |||||
| label: Are you willing to submit a PR? | |||||
| description: > | |||||
| (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. | |||||
| See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started. | |||||
| options: | |||||
| - label: Yes I'd like to help by submitting a PR! |
+ 0
- 12
.github/ISSUE_TEMPLATE/question.md
View File
| --- | |||||
| name: "❓Question" | |||||
| about: Ask a general question | |||||
| title: '' | |||||
| labels: question | |||||
| assignees: '' | |||||
| --- | |||||
| ## ❔Question | |||||
| ## Additional context |
+ 33
- 0
.github/ISSUE_TEMPLATE/question.yml
View File
| name: ❓ Question | |||||
| description: Ask a YOLOv5 question | |||||
| # title: " " | |||||
| labels: [question] | |||||
| body: | |||||
| - type: markdown | |||||
| attributes: | |||||
| value: | | |||||
| Thank you for asking a YOLOv5 ❓ Question! | |||||
| - type: checkboxes | |||||
| attributes: | |||||
| label: Search before asking | |||||
| description: > | |||||
| 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. | |||||
| options: | |||||
| - label: > | |||||
| 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. | |||||
| required: true | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Question | |||||
| description: What is your question? | |||||
| placeholder: > | |||||
| TIP: Include as much information as possible (screenshots, links, reference etc.) to receive the most helpful response. | |||||
| validations: | |||||
| required: true | |||||
| - type: textarea | |||||
| attributes: | |||||
| label: Additional | |||||
| description: Anything else you would like to share? |
Loading…