Create an issue template for incompatible rendering

1 files changed, 129 insertions, 0 deletions

diff --git a/.github/ISSUE_TEMPLATE/wrong-rendering-report.yml b/.github/ISSUE_TEMPLATE/wrong-rendering-report.yml
new file mode 100644
index 0000000..7fe9903
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/wrong-rendering-report.yml
@@ -0,0 +1,129 @@
+name: Wrong rendering report
+description: Report subtitles that look wrong (different from VSFilter)
+title: 'Rendering: '
+labels: compatibility
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for filing an issue!
+        To help us determine what's causing your issue, please take your time to read
+        and fill out everything with as much detail as you can.
+
+        If you're encountering the problem with an old version of libass,
+        please retest with current git-master or the latest release if possible.
+        Also, if you have the chance to:
+
+        **Compare to VSFilter**
+
+        Before reporting an issue, if possible, check what your file looks like
+        in a video player that uses VSFilter to render subtitles (for example, MPC-HC).
+        If it looks the same, even if it still feels wrong, this is probably intentional
+        and not an issue with libass.
+
+  - type: textarea
+    id: issue-screenshots
+    attributes:
+      label: Screenshots
+      description: >
+        If possible, add a screenshot of the file in libass (mpv, VLC, Kodi, MPlayer) that shows the 
+        wrong rendering, and a screenshot of the same file in a different renderer/video player
+        (for example, MPC-HC) that shows the correct rendering.
+
+  - type: textarea
+    id: issue-description
+    validations:
+      required: true
+    attributes:
+      label: Description of the issue
+      description: >
+        Tell us clearly and concisely what you think looks wrong. Even if you show a screenshot,
+        it is not always obvious to another person what you think is the problem.
+
+  - type: input
+    id: libass-version
+    validations:
+      required: true
+    attributes:
+      label: libass version
+      description: >
+        What version of libass are you encountering this issue on?
+        If you aren't sure how to find this out, give precise information
+        on your player, its version and where you got the player-binary from.
+
+        If you uploaded a correct screenshot for comparison and haven't told us already,
+        please also specify what renderer and which version of it gave you the correct result.
+
+  - type: input
+    id: libass-regression
+    attributes:
+      label: Is it a regression?
+      description: >
+        Did previous libass samples render the sample better?
+        Or is this a recent change (since when)?
+
+  - type: textarea
+    id: issue-sample
+    attributes:
+      label: ASS Sample
+      description: >
+        If possible, show an excerpt of the ASS script that looks wrong.
+        Include the relevant Dialogue and Style lines.
+        The excerpt should basically be a fully functional ASS file in itself.
+        If you can’t make an excerpt, we can work with a full ASS file
+        if you tell us the time at which the problem occurs.
+
+        If you see the problem only with a particular video file that contains subtitles,
+        try to upload a short cut from the video file that we can play to see the problem.
+        You can use tools such as MKVToolNix to make a smaller cut from a large file.
+      placeholder: |
+        If it isn't too long paste the ASS-excerpt enclosed in triple-backticks as below, or upload a sample file
+
+        ```
+        [Script Info]
+        ```
+
+  - type: dropdown
+    id: issue-sample-font
+    validations:
+      required: true
+    attributes:
+      label: Special Fonts
+      description: >
+        Many issues only manifest with specific fonts.
+        If a particular font is needed to see the wrong rendering,
+        upload it as a zipped file inside the previous textarea if you have permission to do so.
+        If it is a font freely available on the Web, you can instead give a link to it.
+      options:
+        - I uploaded or linked to the required font
+        - The issue doesn't depend on a specific font
+
+  - type: textarea
+    id: system
+    attributes:
+      label: System Information
+      description: >
+        Tell us what system you're seeing the issue on (including the OS update level if applicable).
+        If VSFilter and libass screenshots were taken on different systems, give the info for both.
+      placeholder: |
+        OS:  *(\*Linux, MacOS, Windows, …)*
+        CPU: *(32 or 64Bit AMD/Intel x86, ARM, POWER, …)*
+        e.g. MacOS 10.5 with a 64bit x86 (Intel) CPU
+
+  - type: textarea
+    id: log
+    attributes:
+      label: Log
+      description: >
+        A complete log is very helpful to find out what's going wrong.
+        If you have logs regarding the issue please include them. Eg for [mpv](https://github.com/mpv-player/mpv),
+        you can obtain a log by adding `--log-file=output.txt` when playing the affected file.
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional info
+      description: >
+        Feel free to add anything else that may be useful.