From 911c0659eb723dc81e6c0d605beb98ecf0506b53 Mon Sep 17 00:00:00 2001 From: Kazuki Matsumoto <1132081+karasusan@users.noreply.github.com> Date: Fri, 4 Feb 2022 10:42:17 +0900 Subject: [PATCH] chore: Create GitHub Issue forms (#629) --- .github/ISSUE_TEMPLATE/bug_report.md | 34 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 61 ++++++++++++++ README.md | 24 +++--- 5 files changed, 169 insertions(+), 67 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 88524c25..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: karasusan - ---- - -**Describe the bug** -A clear and concise description of what the bug is. -If you want to ask the question, you can post the message on the [Unity Forum](https://forum.unity.com/threads/unity-render-streaming-introduction-faq.742481/). - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - - OS: [e.g. iOS, Windows] - - Browser [e.g. chrome, safari] - - Unity Version [e.g. 2019.3.9] - - Package version [e.g. 2.0.0-preview] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..4fcbfec8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ +name: Bug report +description: Create a report to help us improve. +title: "[BUG]: " +labels: + - bug +assignees: + - karasusan +body: + - type: markdown + attributes: + value: | + Please check below before post your issue. + * For questions, ask in [Unity Forum](https://forum.unity.com/forums/unity-render-streaming.413). + * Before you file an issue read the [Contributing guide](https://github.com/Unity-Technologies/com.unity.webrtc/blob/develop/CONTRIBUTING.md). + * Check to make sure someone hasn't already opened a similar [issue](https://github.com/Unity-Technologies/com.unity.webrtc/issues). + + Please note the following points. + * We try to reply as soon as possible but we will get in touch with you within **5 working days**. + * If you solved the issue yourself, please **post the comment and close your issue**. + * We would close the issue if we do not receive a reply for more than **2 weeks**. + + - type: dropdown + id: version + attributes: + label: Package version + description: | + What version of the package are you using? + You can check the Unity version in Package Manager Window. See [manual](https://docs.unity3d.com/Manual/upm-ui.html). + options: + - 3.1.0-exp.3 + - 3.1.0-exp.2 + - 3.1.0-exp.1 + - Others + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: | + Please describe your environment when the issue occurred. + Example: + - **OS**: Windows10 + - **Unity version**: Unity 2021.2 + - **Graphics API**: DirectX11 + - **Browser**: Google Chrome Version 97 + value: | + * OS: + * Unity version: + * Graphics API: + * Browser: + render: markdown + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + + - type: textarea + id: anything-else + attributes: + label: Anything else? + description: | + Links? Reference? Anything that will give us more context about the issue you are encountering! + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + placeholder: | + Drag and drop image or text files here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index df3bbf34..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[REQUEST]" -labels: enhancement -assignees: karasusan - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -If you want to ask the question, you can post the message on the [Unity Forum](https://forum.unity.com/threads/unity-render-streaming-introduction-faq.742481/). - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..5bbf443f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,61 @@ +name: Feature request +description: Suggest an idea for this project. +title: "[REQUEST]: " +labels: + - enhancement +assignees: + - karasusan +body: + - type: markdown + attributes: + value: | + Please check below before post your issue. + * For questions, ask in [Unity Forum](https://forum.unity.com/forums/unity-render-streaming.413). + * Before you file an issue read the [Contributing guide](https://github.com/Unity-Technologies/UnityRenderStreaming/blob/develop/CONTRIBUTING.md). + * Check to make sure someone hasn't already opened a similar [issue](https://github.com/Unity-Technologies/UnityRenderStreaming/issues). + + Please note the following points. + * We try to reply as soon as possible but we will get in touch with you within **5 working days**. + * If you solved the issue yourself, please **post the comment and close your issue**. + * We would close the issue if we do not receive a reply for more than **2 weeks**. + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: | + A clear and concise description of what the problem is. + Ex. I'm always frustrated when [...] + value: | + I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + placeholder: | + Drag and drop image or text files here. + validations: + required: false \ No newline at end of file diff --git a/README.md b/README.md index 35a9ec78..cba7b9d8 100644 --- a/README.md +++ b/README.md @@ -40,18 +40,18 @@ Please see [Furioos Tutorial](com.unity.renderstreaming/Documentation~/deploy-to ## Roadmap -| Version | Focus | -| ------- | ----- | -| `1.0-preview` | - First release | -| `1.1-preview` | - Upgrade HDRP version 5.16 | -| `1.2-preview` | - Unity 2019.3 support | -| `2.0-preview` | - Multi camera
- DirectX12 (DXR) Support | -| `2.1-preview` | - Unity 2019.4 support
- Add bitrate control sample | -| `2.2-preview` | - Add video receiver
- HDRP/URP on Linux support | -| `3.0-preview` | - iOS platform support
- AR Foundation sample | -| `3.1-exp.1` | - Android platform support | -| `3.1-exp.2` | - Audio Renderer support
- Multiplay sample
- M1 Mac support | - +| Version | Focus | When | +| ------- | ----- | ----- | +| `1.0.0-preview` | - First release | Aug 2019 | +| `1.1.0-preview` | - Upgrade HDRP version 5.16 | Sep 2019 | +| `1.2.0-preview` | - Unity 2019.3 support | Feb 2020 | +| `2.0.0-preview` | - Multi camera
- DirectX12 (DXR) Support | Apr 2020 | +| `2.1.0-preview` | - Unity 2019.4 support
- Add bitrate control sample | Aug 2020 | +| `2.2.0-preview` | - Add video receiver
- HDRP/URP on Linux support | Nov 2020 | +| `3.0.0-preview` | - iOS platform support
- AR Foundation sample | Mar 2021 | +| `3.1.0-exp.1` | - Android platform support | Jun 2021 | +| `3.1.0-exp.2` | - Audio Renderer support
- Multiplay sample
- M1 Mac support | Dec 2021 | +| `3.1.0-exp.3` | - Fix bugs | Feb 2022 | ## FAQ