From fbfe319b36bbb007879a2997243162aba2edec01 Mon Sep 17 00:00:00 2001 From: Arkadiusz Fal Date: Mon, 5 Dec 2022 00:29:49 +0100 Subject: [PATCH] Update templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 47 ++++++++++----------- .github/ISSUE_TEMPLATE/feature-request.yaml | 41 +++++++++--------- ISSUE_TEMPLATE.md | 0 README.md | 22 +--------- 4 files changed, 44 insertions(+), 66 deletions(-) delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index a4352e38..9004c75a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -5,61 +5,58 @@ body: - type: markdown attributes: value: | - **README: Before You Submit Your Issue** - - Issues are not a place to ask support questions or discussions. Please ask any questions or discussions on the [Matrix Channel](https://matrix.to/#/#yattee:matrix.org) or [discussions page](https://github.com/yattee/yattee/discussions). - - Also check the [Wiki](https://github.com/yattee/yattee/wiki) for any information or FAQs that help you with yattee. - + **Before You Submit Your Issue** + - This is not a right place to ask questions. Use [Discussions](https://github.com/yattee/yattee/discussions) or contact directly via [Discord](https://yattee.stream/discord) or [Matrix Channel](https://matrix.to/#/#Yattee:matrix.org) + - type: checkboxes attributes: label: Guidelines - description: Please ensure you've completed all of the following. + description: Please ensure you've completed the following options: - - label: I have searched the [issue tracker](https://github.com/yattee/yattee/issues) for a bug report but haven't found the one that I'm opening for. + - label: I have searched the [issue tracker](https://github.com/yattee/yattee/issues) and I haven't found bug report like this required: true - type: textarea attributes: label: Current Behavior - description: Tell us what happened and the steps you have done to encounter this bug if possible in clear description? + description: Describe what happened and the steps you have done to encounter the problem validations: required: true - type: textarea attributes: label: Expected Behavior - description: Tell us what you expected to happen in clear description? + description: Describe what you expected to happen validations: required: true - type: input attributes: label: Device & OS Version - description: What Device and version are you running? - placeholder: e.g. iPhone (iOS 15.5) + description: What device and operating system version are you running? You can find it in device settings + placeholder: e.g. iPhone, iOS 16.1 validations: required: true - type: input attributes: - label: App Version - description: What version are you running? - placeholder: e.g. 1.4 - validations: - required: true - - - type: dropdown - attributes: - label: App Installation Method - options: - - TestFlight - - ipa (GitHub Releases) + label: App Build + description: What build of the application are you running? You can find this in the bottom of the Settings page + placeholder: e.g. 112 validations: required: true + - type: textarea + attributes: + label: App Settings + description: If the issue is related to some non-default configuration, please provide the settings you have changed + validations: + required: false + - type: textarea attributes: label: Crash log - description: Submit your crash log if available + description: If you are reporing a crash, attach crash log here placeholder: | 1. Go to 'Settings' 2. Click on 'Privacy' @@ -71,7 +68,7 @@ body: - type: textarea attributes: - label: Screenshots or Videos - description: If possible, submit your screenshots or a video of the bug that you have encountered to better understanding + label: Screenshots, Videos and other files + description: Submit screenshots, video of the issue or other files that can help to understand the problem better. If you are reporting issue with playback in MPV, attach [logs from MPV](https://github.com/yattee/yattee/wiki/Getting-MPV-logs) validations: required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 6caf57dd..ae99f400 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -1,40 +1,39 @@ name: Feature request description: Suggest an new feature or an idea to improve the existing one -title: "[Feature Request]: " labels: "enhancement" body: - type: markdown attributes: value: | - **README: Before You Submit Your Issue** - - Issues are not a place to ask support questions or discussions. Please ask any questions or discussions on the [Matrix Channel](https://matrix.to/#/#yattee:matrix.org) or [discussions page](https://github.com/yattee/yattee/discussions). - - Also check the [Wiki](https://github.com/yattee/yattee/wiki) for any information or FAQs that help you with yattee. - + **Before You Submit Your Issue** + - This is not a right place to ask questions. Use [Discussions](https://github.com/yattee/yattee/discussions) or contact directly via [Discord](https://yattee.stream/discord) or [Matrix Channel](https://matrix.to/#/#Yattee:matrix.org) + - type: checkboxes attributes: label: Guidelines - description: Please ensure you've completed all of the following. + description: Please ensure you've completed the following options: - - label: I have searched the [issue tracker](https://github.com/yattee/yattee/issues) for the feature request but haven't found the one that I'm opening for. + - label: I have searched the [issue tracker](https://github.com/yattee/yattee/issues) and I haven't found feature request like this required: true - - type: textarea - attributes: - label: Describe your idea or suggested feature - description: Provide a clear description of the idea or feature that you're requesting to have implemented. Also in a image/video of the feature request if available. - placeholder: The feature should work like this... - validations: - required: true - - type: dropdown attributes: - label: 'Labels' - description: Please select a label that fits this feature request. Choose multiple label options, if applicable. + label: Type + description: Please select a type that fits this request. Choose multiple options, if applicable multiple: true options: - - ease of use improvement - - improvement to existing feature - - new feature - - visual improvement + - New feature + - Improvement to existing feature + - Usability improvement + - Visual improvement + - Other + validations: + required: true + + - type: textarea + attributes: + label: Describe the feature + description: Provide a description of the feature that you're requesting to have implemented. You can attach screenshots or mockups to help to understand it better + placeholder: The feature should work like this... validations: required: true diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index e69de29b..00000000 diff --git a/README.md b/README.md index b8913d4d..b74d37e5 100644 --- a/README.md +++ b/README.md @@ -20,33 +20,15 @@ ## Features * Native user interface built with [SwiftUI](https://developer.apple.com/xcode/swiftui/) with customization settings -* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip * Player queue and history * Player component with custom controls, gestures and support for 4K playback * Fullscreen, Picture in Picture and background audio playback - -### Availability -|| Invidious | Piped | -| - | - | - | -| User Accounts | ✅ | ✅ | -| Subscriptions | ✅ | ✅ | -| User Playlists | ✅ | ✅ | -| Trending | ✅ | ✅ | -| Channels | ✅ | ✅ | -| Channel Playlists | ✅ | ✅ | -| Search | ✅ | ✅ | -| Search Suggestions | ✅ | ✅ | -| Comments | ✅ | ✅ | -| Subtitles | ✅ |🔴 | -| Search Filters | ✅ | 🔴 | -| Popular | ✅ | 🔴 | - -You can browse and use accounts from one app and play videos with another (for example: use Invidious account for subscriptions and use Piped as playback source). Comments can be displayed from Piped even when Invidious is used for browsing/playing. +* [SponsorBlock](https://sponsor.ajay.app/), configurable categories to skip ## Documentation * [Installation](https://github.com/yattee/yattee/wiki/Installation-Instructions) * [Building](https://github.com/yattee/yattee/wiki/Building-instructions) -* [FAQ](https://github.com/yattee/yattee/wiki) +* [Features](https://github.com/yattee/yattee/wiki/Features) * [Screenshots Gallery](https://github.com/yattee/yattee/wiki/Screenshots-Gallery) * [Tips](https://github.com/yattee/yattee/wiki/Tips) * [Integrations](https://github.com/yattee/yattee/wiki/Integrations)