summaryrefslogtreecommitdiff
path: root/javascript/videojs/.github/ISSUE_TEMPLATE/bug_report.yaml
blob: a89d04c2039a2a83f9925c2bf281466f450757a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
name: General issue
description: Report a general issue with Video.js
labels: "needs: triage"
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 and closed issues. Your new comment is unlikely to be noticed.
          * Take care to make sure it is really the exact same issue. Conflating tangentially related issues is counterproductive. If in doubt, open as a new issue.
          * Add useful new information, such as a new reproducible case to help narrow down the issue.
        * If the issue is with a specific plugin, it's generally 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
    validations:
      required: true
    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.
        **Without a test case** it's unlikely your issue can be actioned.
        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