From 3611e24530dfc6875eaa2fba7dc7e35419fbb16f Mon Sep 17 00:00:00 2001 From: Dimitri Podborski Date: Tue, 29 Aug 2023 18:50:35 -0700 Subject: [PATCH 1/2] issue templates stuff --- .../ISSUE_TEMPLATE/conformance-file-issue.yml | 51 +++++++++++++++++++ .github/ISSUE_TEMPLATE/page-bug.yml | 1 - .github/ISSUE_TEMPLATE/spec-issue.yml | 29 +++++++++++ 3 files changed, 80 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/conformance-file-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/spec-issue.yml diff --git a/.github/ISSUE_TEMPLATE/conformance-file-issue.yml b/.github/ISSUE_TEMPLATE/conformance-file-issue.yml new file mode 100644 index 0000000..bfa4e12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/conformance-file-issue.yml @@ -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: true + + - 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: true + + - 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 diff --git a/.github/ISSUE_TEMPLATE/page-bug.yml b/.github/ISSUE_TEMPLATE/page-bug.yml index 627bfb0..7fb029a 100644 --- a/.github/ISSUE_TEMPLATE/page-bug.yml +++ b/.github/ISSUE_TEMPLATE/page-bug.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/spec-issue.yml b/.github/ISSUE_TEMPLATE/spec-issue.yml new file mode 100644 index 0000000..344af44 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spec-issue.yml @@ -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 From 1837fcc530c3122f113b7eebcc59141ef01ba40b Mon Sep 17 00:00:00 2001 From: Dimitri Podborski Date: Wed, 30 Aug 2023 16:43:29 -0700 Subject: [PATCH 2/2] make some fields optional --- .github/ISSUE_TEMPLATE/conformance-file-issue.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/conformance-file-issue.yml b/.github/ISSUE_TEMPLATE/conformance-file-issue.yml index bfa4e12..8b683f3 100644 --- a/.github/ISSUE_TEMPLATE/conformance-file-issue.yml +++ b/.github/ISSUE_TEMPLATE/conformance-file-issue.yml @@ -26,7 +26,7 @@ body: 1. Download file `foo.mp4` 2. ... validations: - required: true + required: false - type: textarea id: affected-specifications @@ -37,7 +37,7 @@ body: - ISO/IEC 14496-12 - ISO/IEC 14496-15 validations: - required: true + required: false - type: textarea id: affected-files