diff --git a/.github/DISCUSSION_TEMPLATE/1.feature_proposal.yml b/.github/DISCUSSION_TEMPLATE/1.feature_proposal.yml new file mode 100644 index 00000000..72b0ce01 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/1.feature_proposal.yml @@ -0,0 +1,55 @@ +title: '[Feature Proposal] ' +labels: ['feature: proposal'] +body: + - type: markdown + attributes: + value: | + This is text that will show up in the template! + - type: textarea + id: improvements + attributes: + label: Top 3 improvements + description: What are the top 3 improvements we could make to this project? + value: | + 1. + 2. + 3. + ... + render: bash + validations: + required: true + - type: markdown + attributes: + value: | + ## Markdown header + And some more markdown + - type: input + id: has-id + attributes: + label: Suggestions + description: A description about suggestions to help you + validations: + required: true + - type: dropdown + id: download + attributes: + label: Which area of this project could be most improved? + options: + - Documentation + - Pull request review time + - Bug fix time + - Release cadence + validations: + required: true + - type: checkboxes + attributes: + label: Check that box! + options: + - label: This one! + required: true + - label: I won't stop you if you check this one, too + - type: markdown + attributes: + value: | + ### The thrilling conclusion + _to our template_ diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml new file mode 100644 index 00000000..e78071a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -0,0 +1,107 @@ +name: 🐛 Bug Report +description: Report a reproducible bug or regression. +type: bug +labels: ['status: unconfirmed', bug] +title: 'Bug: ' +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to file a bug report! Please fill this template out as completely as possible. + * If you are not reporting a bug, but want to ask a general question, use [discussions](https://github.com/videojs/v10/discussions) instead. + * Check the [docs](https://v10.videojs.org/docs). + * Please check to see if there's an existing issue and replying there instead. + * Please give as much details as you can. Ideally, include a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: dropdown + id: affected + validations: + required: true + attributes: + label: Which package(s) or projects are affected? + multiple: true + description: Note you can select more than one. + options: + - Core (@videojs/core) + - Icons (@videojs/icons) + - HTML (@videojs/html) + - React (@videojs/react) + - Utils (@videojs/utils) + - Website + - Example / Demo Apps (html-demo, react-demo, next-demo) + - Other/unknown (please mention in description) + - type: textarea + id: environment + validations: + required: true + attributes: + label: Browser/OS/Node environment + description: | + Please list which browser(s) and operating system(s) combination(s) you are using, and/or if this bug affects a command-line tool, please list your Node and npm versions. + placeholder: | + Browser: Chrome 103.0.5060.53 + OS: macOS 12.4 + Node version: 16.15.0 + npm version: 8.11.0 + - type: textarea + id: description + attributes: + label: Description + description: | + Please provide a clear and concise description of what the bug is. Include + screenshots if needed. Please test using the latest version of the relevant + Mux Elements packages to make sure your issue has not already been fixed. + validations: + required: true + - type: input + id: testcase + attributes: + label: Reduced test case + description: | + Please add a URL to a [reminimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). + This can be a codesandbox, a GitHub repo, or similar. + Providing makes it easier to reproduce the issue and getting it fixed. + placeholder: https:// + - type: textarea + id: str + attributes: + label: Steps to reproduce + description: | + Detailed steps to reproduce the issue. + Your bug will get fixed much faster if we can run your code and it's clear how to reproduce the issue. + Issues without reproduction steps or code examples may be immediately closed as not actionable. + value: | + 1. + 2. + 3. + validations: + required: true + - type: textarea + id: actualbehavior + attributes: + label: Current Behavior + validations: + required: true + - type: textarea + id: expectedbehavior + attributes: + label: Expected Behavior + validations: + required: true + - type: textarea + id: errors + attributes: + label: Errors + description: If you see any errors in the console, please include them there + - type: input + id: version + attributes: + label: What version of the package are you using? + description: Please include the version you are using. If you are not using the latest version, please explain why in the description above. + placeholder: vX.Y.Z diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml new file mode 100644 index 00000000..bf5f1b42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -0,0 +1,83 @@ +name: 💎 Feature Request +description: Request a new feature or enhancement +type: enhancement +labels: [] +title: 'Feature Request: ' +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to file an enhancement report report! Please fill this template out as completely as possible. + * If you are not requesting a new feature or enhancement, but want to ask a general question, use [discussions](https://github.com/videojs/v10/discussions) instead. + * Check the [docs](https://v10.videojs.org/docs). + * Please check to see if there's an existing issue or discussion and, if so, reply there instead. + * Please provide as much detail as you can. + - type: checkboxes + attributes: + label: Should this be a feature proposal discussion? + description: | + Video.js 10 currently uses [feature proposal discussions](https://github.com/videojs/v10/discussions) for larger feature requests, proposals, and discussions + options: + - label: This is not a substantial change + required: true + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: dropdown + id: packages + validations: + required: true + attributes: + label: Which package(s) does this apply to? Select all that apply + multiple: true + options: + - Core (@videojs/core) + - Icons (@videojs/icons) + - HTML (@videojs/html) + - React (@videojs/react) + - Utils (@videojs/utils) + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + What are you trying to accomplish? Which kind of user is this for? Providing context helps us come up with a solution that is more useful in the real world. + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + description: | + Please provide as much information about the feature or enhancement as + possible. Include images or screenshots if needed. + - type: textarea + id: expectedbehavior + validations: + required: true + attributes: + label: Expected Behavior + - type: textarea + id: alternatives + validations: + required: true + attributes: + label: Alternatives and Workarounds + description: | + Please describe any alternatives or workarounds you have considered that could be used instead of this feature. + placeholder: | + It's possible to achieve the same result by waiting for the `loadstart` event and manually invoking the `foo()` method, but this is creates significantly more complexity for developers compared to the proposal. + - type: textarea + id: prior-art + validations: + required: false + attributes: + label: Examples in other libraries + description: | + Provide links to any equivalent examples of this feature or functionality implemented in other libraries (if applicable). diff --git a/.github/ISSUE_TEMPLATE/3.docs_feedback.yml b/.github/ISSUE_TEMPLATE/3.docs_feedback.yml new file mode 100644 index 00000000..815ca1ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3.docs_feedback.yml @@ -0,0 +1,56 @@ +name: 📄 Docs Request +description: Report a discrepancy in or an improvement to the docs. +labels: [documentation] +title: 'Docs: ' +body: + - type: markdown + attributes: + value: | + Thanks for helping us improve our documentation! Please fill this template out as completely as possible. + * If you are not reporting a bug, but want to ask a general question, use [discussions](https://github.com/videojs/v10/discussions) instead. + * Check the [docs](https://v10.videojs.org/docs). + * Please check to see if there's an existing issue and replying there instead. + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: dropdown + id: packages + attributes: + label: Which documentation could use some work? + multiple: true + options: + - Core (@videojs/core) + - Icons (@videojs/icons) + - HTML (@videojs/html) + - React (@videojs/react) + - general framework documentation + validations: + required: true + - type: dropdown + id: docs-type + attributes: + label: Is this a discrepancy or an improvement? + multiple: true + options: + - discrepancy + - improvement + validations: + required: true + - type: textarea + id: description + attributes: + label: 🖊 Describe what you'd like to see change in the documentation + description: Please provide a clear and concise description of what you want to see changed. If applicable, provide screenshots and/or videos. + validations: + required: true + - type: textarea + id: why-description + attributes: + label: 💡 Describe how you think this change will help the documentation + description: Please provide a clear and concise description of why you think this would improve our documentation + validations: + required: true