chore: update issue templates #19
Conversation
|
@yokuze @onebytegone @jimjenkins5 what do you think of adding these issue templates to our projects? These are a bit tuned towards our VideoJS projects (the MCVE examples, in particular). I'm thinking we use these across our VideoJS plugins, and then tweak that MCVE part so that a more generic version could be used across the rest of our FOSS repos. |
| --- | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. |
There was a problem hiding this comment.
Normally on these issue templates the instructions go into comments. I think that provides 2 benefits:
- It's easy for the user to see what should be taken out of the final report and what should be left in (i.e. headings, etc.)
- We never see the cruft in the rendered issue, even if the user forgets/doesn't delete the instructions.
For example, notice ESLint's issue templates:
https://github.com/eslint/eslint/blob/master/.github/ISSUE_TEMPLATE/BUG_REPORT.md
| - Browser [e.g. chrome, safari] | ||
| - Version [e.g. 22] | ||
|
|
||
| **Smartphone (please complete the following information):** |
There was a problem hiding this comment.
Should we title this "Mobile" instead of "Smartphone" since tablets like iPads wouldn't fall into either the "Desktop" or "Smartphone" categories?
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| **Desktop (please complete the following information):** | ||
| - OS: [e.g. iOS] |
There was a problem hiding this comment.
Probably should be something like: e.g. macOS 10.14.6 since this is the "Desktop" section
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** |
There was a problem hiding this comment.
Not a big deal, but this is Title Case and all of the other titles are sentence case
| --- | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. |
No description provided.