Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update issue templates #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,49 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally on these issue templates the instructions go into comments. I think that provides 2 benefits:

  1. 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.)
  2. 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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense to me too


**To Reproduce**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big deal, but this is Title Case and all of the other titles are sentence case

If you'd like assistance, you will need to post a [minimal, complete, verifiable example](https://stackoverflow.com/help/minimal-reproducible-example). (MCVE) Sometimes just by creating a MCVE you will actually discover the source of the problem yourself - or at least more details to help us reproduce it.

If you want some good examples of MCVE's, see a couple of issues that we have posted elsewhere, e.g:

* https://github.com/videojs/video.js/issues/4765
* https://github.com/videojs/http-streaming/issues/172

All of that detail is really important in getting help - especially on an open source plugin where people are donating their time. Without it we can't be sure what version of VideoJS you're using, or what other plugins you're using with it.

If you are unable to create an MCVE, you may still open a defect, but you must provide as much detail as possible. Defects opened without an MCVE have a much greater chance of being closed without investigation. Please remember: we are volunteers and do not have time to debug applications for every user that uses our plugins. If you show that you've put the effort into trying to debug it yourself and provide us with an MCVE and as much detail as possible, we will be much more interested in assisting you.

Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should be something like: e.g. macOS 10.14.6 since this is the "Desktop" section

- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we title this "Mobile" instead of "Smartphone" since tablets like iPads wouldn't fall into either the "Desktop" or "Smartphone" categories?

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE REQUEST]"
labels: ''
assignees: ''

---

Feel free to submit feature requests if you see something that you really think could be an enhancement to this project. However, please note: we do not promise to implement feature requests. We are volunteers working on this project for free. If a feature request seems beneficial for the project, we will work on it as time allows. We encourage you to consider implementing the feature request yourself. Well-written pull requests to add features that show that they have a high quality and are well tested will be accepted if they comply with our [coding standards](https://github.com/silvermine/silvermine-info/blob/master/coding-standards.md).

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.