Skip to content

Commit

Permalink
Merge pull request #54 from MPEGGroup/issue_templates
Browse files Browse the repository at this point in the history
Issue templates
  • Loading branch information
podborski authored Aug 31, 2023
2 parents b0b1648 + a5f21bf commit 567e9dd
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 1 deletion.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/conformance-file-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 🔥 Conformance File Issue
description: Use this template if something is wrong with conformance files
labels: ["conformance issue"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug in the conformance files.
Please fill out the following template to help us reproduce the issue.
- type: textarea
id: summary
attributes:
label: Summary
description: Provide a description of the problem. What is wrong in the files?
placeholder: "File `foo.mp4` has a wrong value for `bar`"
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: What steps do we need to follow to see the problem with our own eyes?
placeholder: |
1. Download file `foo.mp4`
2. ...
validations:
required: false

- type: textarea
id: affected-specifications
attributes:
label: Affected specifications
description: Provide a list of specs which are relevant for this issue.
placeholder: |
- ISO/IEC 14496-12
- ISO/IEC 14496-15
validations:
required: false

- type: textarea
id: affected-files
attributes:
label: Affected files
description: Provide the files like this.
placeholder: |
- [file1.mp4](./data/file_features/published/isobmff/file1.mp4)
- [file2.mp4](./data/file_features/published/isobmff/file2.mp4)
validations:
required: true
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/page-bug.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: 🌎 Website Bug
description: Use this template if something is wrong with the website. This may include visual bugs, typos, broken links, etc.
title: "[Website] "
labels: ["website"]
body:
- type: markdown
Expand Down
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/spec-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 📚 Specification related issue
description: Use this template if something is wrong with the data we extracted from the specifications.
labels: ["inconsistent data"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug.
Please fill out the following template to help us understanding the issue.
- type: textarea
id: summary
attributes:
label: Summary
description: Provide a description of the problem. What is wrong?
placeholder: "The ISOBMFF spec defines this, but the data seems to be not available on this repository."
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: (If applicable) What steps do we need to follow to see the problem with our own eyes?
placeholder: |
1. Do this
2. And then do this
validations:
required: false

0 comments on commit 567e9dd

Please sign in to comment.