New issue templates #4299
New issue templates #4299
Conversation
There was a problem hiding this comment.
Overall it looks nice, clean and the format is likely to improve the quality of the new issues.
My only concern is about the number of mandatory fields for reporting bugs (currently 5 fields). While it's good that we ask the users to provide as much information as possible, adding so many mandatory steps might present a barrier. This might also be annoying to us the developers as often we want to raise a quick bug report/issue and continue our work (see some examples of such quick bug reports you authored in the past: #4278, #4245, #4006).
For the above reasons, I would be in favour of removing the mandatory fields for all issue submissions except the title and the first description.
I was just following our current template, but I agree there are too many fields and they are actually redundant with each others. I personally find it very cumbersome. I simplified the bug-reporting template to only contain 2 mandatory fields: the bug report (with code snippet and error backtrace), and the versions snippet: https://github.com/NicolasHug/vision/issues/new?assignees=&labels=&template=bug-report.yml I often find myself writing comments like "thanks for the report, would you mind pasting the version information after running [...] as indicated in the issue template?", so I think making these fields mandatory is needed and will save time overall.
I agree with this as well, this is why I kept the "blank" issue form as described above. We and other experienced bug-reporters can always use this instead to save time. |
| python collect_env.py | ||
| ``` | ||
| validations: | ||
| required: true |
There was a problem hiding this comment.
Personally I would consider making this also non mandatory, as we often report quick bugs on main branch. Of course one could argue that providing the date/hashcode of main would be beneficial, so I don't feel too strongly about this.
There was a problem hiding this comment.
I agree, but TBF I don't think we (maintainers) will ever be using the bug-report template, I think we'll just use the blank template.
I prefer keeping this mandatory as this is a very common omission from "casual" bug reporters. Thanks for the reviews @datumbox , I'll merge as-is and we can always revisit the fields in a near future if we want to!
|
Thanks for the review! I'll explicitly ignore the tags because it's a bit of an outlier PR... could be "code-quality" or "ci", not sure it matters much :) |
Reviewed By: fmassa Differential Revision: D30793327 fbshipit-source-id: 26317f10a4d620566445c4c21639511a41b79912
Summary: This PR introduces the new issue forms that replace issue templates. This is similar to what was done in torchvision pytorch/vision#4299 and torchaudio, you can see the end result here: https://github.com/pytorch/vision/issues/new/choose (click e.g. on the [bug report](https://github.com/pytorch/vision/issues/new?assignees=&labels=&template=bug-report.yml)) The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions. There is still a "blank" template available. I removed the "Questions" form: we say we close these issues anyway. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly. Pull Request resolved: #65917 Reviewed By: VitalyFedyunin Differential Revision: D31894777 Pulled By: NicolasHug fbshipit-source-id: fbd39f7ed4cadab732d106d3166c04c451c31f94
This PR introduces the new issue forms that replace issue templates. (This is exactly the same as #65917 which was reverted due to an issue during the import) This is similar to what was done in torchvision pytorch/vision#4299 and torchaudio, you can see the end result here: https://github.com/pytorch/vision/issues/new/choose (click e.g. on the [bug report](https://github.com/pytorch/vision/issues/new?assignees=&labels=&template=bug-report.yml)) The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions. There is still a "blank" template available. I removed the "Questions" form: we say we close these issues anyway. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly. [ghstack-poisoned]
Summary: Pull Request resolved: #69361 This PR introduces the new issue forms that replace issue templates. (This is exactly the same as #65917 which was reverted due to an issue during the import) This is similar to what was done in torchvision pytorch/vision#4299 and torchaudio, you can see the end result here: https://github.com/pytorch/vision/issues/new/choose (click e.g. on the [bug report](https://github.com/pytorch/vision/issues/new?assignees=&labels=&template=bug-report.yml)) The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions. There is still a "blank" template available. I removed the "Questions" form: we say we close these issues anyway. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly. Test Plan: Imported from OSS Reviewed By: albanD, mrshenli Differential Revision: D32947189 Pulled By: NicolasHug fbshipit-source-id: f19abe3e7c9c479b0b227969a207916db5bdb6e3
Summary: Pull Request resolved: #69361 This PR introduces the new issue forms that replace issue templates. (This is exactly the same as #65917 which was reverted due to an issue during the import) This is similar to what was done in torchvision pytorch/vision#4299 and torchaudio, you can see the end result here: https://github.com/pytorch/vision/issues/new/choose (click e.g. on the [bug report](https://github.com/pytorch/vision/issues/new?assignees=&labels=&template=bug-report.yml)) The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions. There is still a "blank" template available. I removed the "Questions" form: we say we close these issues anyway. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly. Test Plan: Imported from OSS Reviewed By: albanD, mrshenli Differential Revision: D32947189 Pulled By: NicolasHug fbshipit-source-id: f19abe3e7c9c479b0b227969a207916db5bdb6e3
Summary: Pull Request resolved: #69361 This PR introduces the new issue forms that replace issue templates. (This is exactly the same as #65917 which was reverted due to an issue during the import) This is similar to what was done in torchvision pytorch/vision#4299 and torchaudio, you can see the end result here: https://github.com/pytorch/vision/issues/new/choose (click e.g. on the [bug report](https://github.com/pytorch/vision/issues/new?assignees=&labels=&template=bug-report.yml)) The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions. There is still a "blank" template available. I removed the "Questions" form: we say we close these issues anyway. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly. Test Plan: Imported from OSS Reviewed By: albanD, mrshenli Differential Revision: D32947189 Pulled By: NicolasHug fbshipit-source-id: f19abe3e7c9c479b0b227969a207916db5bdb6e3
This PR introduces the new issue forms feature. The new forms are illustrated here: https://github.com/NicolasHug/vision/issues/new/choose
The main new thing is that we can enforce some of the fields to be filled, especially for bug reports. It's also a much cleaner GUI for users IMHO, and we can provide better examples and instructions.
There is still a "blank" template available.
I removed the "Questions" form: we pretend we close these issues but we actually don't. I replaced it with a direct link to https://discuss.pytorch.org. Since we still have a "blank" template, I think this covers all previous use-cases properly.