1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-23 02:04:34 +02:00

chore: Update issue template to a form (#7735)

This commit is contained in:
mister-ben 2022-05-16 23:20:49 +02:00 committed by GitHub
parent 7e2b9ec411
commit 3e40512501
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 77 additions and 31 deletions

View File

@ -1,31 +0,0 @@
## Description
Briefly describe the issue.
Include a [reduced test case](https://css-tricks.com/reduced-test-cases/), we have a [starter template](https://codepen.io/gkatsev/pen/GwZegv?editors=1000#0) on JSBin you can use.
## Steps to reproduce
Explain in detail the exact steps necessary to reproduce the issue.
1.
2.
3.
## Results
### Expected
Please describe what you expected to see.
### Actual
Please describe what actually happened.
### Error output
If there are any errors at all, please include them here.
## Additional Information
Please include any additional information necessary here. Including the following:
### versions
#### videojs
what version of videojs does this occur with?
#### browsers
what browser are affected?
#### OSes
what platforms (operating systems and devices) are affected?
### plugins
are any videojs plugins being used on the page? If so, please list them below.

75
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View File

@ -0,0 +1,75 @@
name: General issue
description: Report a general issue with Video.js
labels: "needs: triage, bug"
body:
- type: markdown
attributes:
value: |
Thank you for using Video.js and contributing by opening an issue. Before you start, please check this list:
* If you are not reporting a bug, but want to ask a general question, use [discussions](https://github.com/videojs/video.js/discussions) instead.
* Check the [FAQ](https://videojs.com/guides/faqs) and [troubleshooting guides](https://videojs.com/guides/troubleshooting).
* If there is an existing open issue for exactly the same problem, comment there instead.
* However, be careful not to comment on old, closed issues, the new comment is unlikely to be noticed.
* Take care to make sure it is really the exact same issue. If in doubt, open as a new issue.
* If the issue is with a specific plugin, it's often better to open an issue on the plugin repository instead.
* Please do take the time to give detailed information, and include a test case. A detailed issue with actionable information will get a better response than a vague anecdote.
- type: textarea
id: description
attributes:
label: Description
description: |
Please give a detailed description of the issue.
What did you expect to happen, and what happened?
validations:
required: true
- type: input
id: testcase
attributes:
label: Reduced test case
description: |
Please add a URL to a [reduced test case](https://stackoverflow.com/help/minimal-reproducible-example) where the issue can be observed. We have a [starter template](https://codepen.io/gkatsev/pen/GwZegv?editors=1000#0) on Codepen.
Providing a test case will improve the chances of someone being able to identify the issue quickly.
For a playback problem, including the stream URL is essential.
placeholder: https://
- type: textarea
id: str
attributes:
label: Steps to reproduce
description: Detailed steps to reproduce the issue.
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: errors
attributes:
label: Errors
description: If there is an error displayed in the player or in the console, please include them here.
- type: input
id: version
attributes:
label: What version of Video.js are you using?
description: Please include all relevant versions. If not using the latest version, explain why not in the description above.
placeholder: e.g. vX.Y.Z
validations:
required: true
- type: input
id: plugins
attributes:
label: Video.js plugins used.
- type: input
id: browser
attributes:
label: What browser(s) including version(s) does this occur with?
placeholder: e.g. Chrome 100
validations:
required: true
- type: input
id: os
attributes:
label: What OS(es) and version(s) does this occur with?
placeholder: e.g. Windows 11
validations:
required: true

2
.github/config.yml vendored
View File

@ -30,3 +30,5 @@ newPRWelcomeComment: |
firstPRMergeComment: >
Congrats on merging your first pull request! 🎉🎉🎉
# Prevent issues being created without using the template
blank_issues_enabled: false