Skip to content

Commit bcb51e7

Browse files
datumboxfacebook-github-bot
authored andcommitted
[fbsync] New issue templates (#4299)
Reviewed By: fmassa Differential Revision: D30793327 fbshipit-source-id: 26317f10a4d620566445c4c21639511a41b79912
1 parent 57e70b9 commit bcb51e7

File tree

8 files changed

+117
-107
lines changed

8 files changed

+117
-107
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us reproduce and fix the bug
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/pytorch/vision/issues?q=is%3Aissue+sort%3Acreated-desc+).
9+
- type: textarea
10+
attributes:
11+
label: 🐛 Describe the bug
12+
description: |
13+
Please provide a clear and concise description of what the bug is.
14+
15+
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for he snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc. For example:
16+
17+
```python
18+
# All necessary imports at the beginning
19+
import torch
20+
import torchvision
21+
from torchvision.ops import nms
22+
23+
# A succinct reproducing example trimmed down to the essential parts:
24+
N = 5
25+
boxes = torch.rand(N, 4) # Note: the bug is here, we should enforce that x1 < x2 and y1 < y2!
26+
scores = torch.rand(N)
27+
nms(boxes, scores, iou_threshold=.9)
28+
```
29+
30+
If the code is too long (hopefully, it isn't), feel free to put it in a public gist and link it in the issue: https://gist.github.com.
31+
32+
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
33+
placeholder: |
34+
A clear and concise description of what the bug is.
35+
36+
```python
37+
Sample code to reproduce the problem
38+
```
39+
40+
```
41+
The error message you got, with the full traceback.
42+
````
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Versions
48+
description: |
49+
Please run the following and paste the output below.
50+
```sh
51+
wget https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py
52+
# For security purposes, please check the contents of collect_env.py before running it.
53+
python collect_env.py
54+
```
55+
validations:
56+
required: true
57+
- type: markdown
58+
attributes:
59+
value: >
60+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Usage questions
4+
url: https://discuss.pytorch.org/
5+
about: Ask questions and discuss with other torchvision community members

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 📚 Documentation
2+
description: Report an issue related to https://pytorch.org/vision/stable/index.html
3+
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: 📚 The doc issue
8+
description: >
9+
A clear and concise description of what content in https://pytorch.org/vision/stable/index.html is an issue. If this has to do with the general https://pytorch.org website, please file an issue at https://github.com/pytorch/pytorch.github.io/issues/new/choose instead. If this has to do with https://pytorch.org/tutorials, please file an issue at https://github.com/pytorch/tutorials/issues/new.
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Suggest a potential alternative/fix
15+
description: >
16+
Tell us how we could improve the documentation in this regard.
17+
- type: markdown
18+
attributes:
19+
value: >
20+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🚀 Feature request
2+
description: Submit a proposal/request for a new torchvision feature
3+
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: 🚀 The feature
8+
description: >
9+
A clear and concise description of the feature proposal
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Motivation, pitch
15+
description: >
16+
Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Alternatives
22+
description: >
23+
A description of any alternative solutions or features you've considered, if any.
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: >
28+
Add any other context or screenshots about the feature request.
29+
- type: markdown
30+
attributes:
31+
value: >
32+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/questions-help-support.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)