1
0
Fork 0
mirror of https://gitlab.com/futo-org/fcast.git synced 2025-06-24 21:25:23 +00:00

Merge branch 'zvonimir-dev' into 'master'

Add Github issue templates

See merge request videostreaming/fcast!8
This commit is contained in:
Michael Hollister 2025-01-13 19:17:12 +00:00
commit b5e9c925e6
4 changed files with 304 additions and 0 deletions

179
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,179 @@
name: Bug Report
description: Let us know about an unexpected error, a crash, or an incorrect behavior.
labels: ["Bug"]
body:
- type: markdown
attributes:
value: |
# Thank you for taking the time to fill out this bug report.
The [fcast](https://github.com/futo-org/fcast) issue tracker is reserved for issues relating to the FCast. Use the `Documentation` issue type to report problems with the documentation in our code repositories, inside the application, or on [https://fcast.org](https://fcast.org)
For general usage questions, please see: [The Official FUTO FCast Zulip Channel](https://chat.futo.org/#narrow/stream/67-FCast)
## Filing a bug report
To fix your issues faster, we need clear reproduction cases - ideally allowing us to make it happen locally.
* Please include all needed context. For example, Device, OS, Application, your Grayjay Configurations and Plugin versioning info.
* if you've found out a particular series of UI interactions can introduce buggy behavior, please label those steps 1-n with markdown
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: replication-steps
attributes:
label: Replication steps
description: To fix your issues faster, we need clear reproduction cases - ideally allowing us to make it happen locally.
placeholder: |
1. Start Youtube video inside Grayjay
2. Click on casting button
3. Select FCast receiver
...
validations:
required: true
- type: dropdown
id: sender
attributes:
label: Which sender are you using?
multiple: false
options:
- "Grayjay"
- "Terminal"
- "Other"
validations:
required: true
- type: input
id: fcast-version
attributes:
label: FCast Receiver Version
description: What is receivers version? For Electron receiver, you can right click the tray icon and select About.
placeholder: "41"
validations:
required: true
- type: input
id: grayjay-version
attributes:
label: Grayjay Version
description: In the application, select More > Settings, scroll to the bottom and locate the value next to "Version Name".
placeholder: "278"
validations:
required: true
condition:
field: sender
value: "Grayjay"
- type: dropdown
id: os
attributes:
label: Which operating system are you using on your receiver?
multiple: false
options:
- "Linux"
- "MacOS"
- "Windows"
- "Android"
- "AndroidTV"
- "Roku"
- "WebOS"
- "TizenOS"
- "tvOS"
validations:
required: true
- type: dropdown
id: protocol
attributes:
label: Which protocol did you use to cast?
multiple: false
options:
- "FCast"
- "Chromecast"
- "Airplay"
validations:
required: true
- type: dropdown
id: plugin
attributes:
label: What plugins are you seeing the problem on?
multiple: true
options:
- "All"
- "Youtube"
- "Odysee"
- "Rumble"
- "Kick"
- "Twitch"
- "PeerTube"
- "Patreon"
- "Nebula"
- "BiliBili (CN)"
- "Bitchute"
- "SoundCloud"
- "Dailymotion"
- "Apple Podcasts"
- "Other"
validations:
required: true
condition:
field: sender
value: "Grayjay"
- type: input
id: plugin-version
attributes:
label: Plugin Version
description: In the application, select Sources > [the broken plugin], write down the value under "Version".
placeholder: "12"
validations:
condition:
field: sender
value: "Grayjay"
- type: checkboxes
id: login
attributes:
label: When do you experience the issue?
options:
- label: While logged in
- label: While logged out
- label: N/A
validations:
condition:
field: sender
value: "Grayjay"
- type: dropdown
id: vpn
attributes:
label: Are you using a VPN?
multiple: false
options:
- "No"
- "Yes"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Logs currently are only easily user-accessible for the Electron receiver.
Electron logs can be found in the following locations:
- **Windows**: `%USERPROFILE%\AppData\Roaming\fcast-receiver\logs\fcast-receiver.log`
- **MacOS**: `~/Library/Logs/fcast-receiver/fcast-receiver.log`
- **Linux**: `~/.config/fcast-receiver/logs/fcast-receiver.log`
render: shell

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Need a Grayjay License?
url: https://pay.futo.org/api/PaymentPortal
about: Purchase a Grayjay license with FutoPay

View file

@ -0,0 +1,64 @@
name: Documentation Issue
description: Report an issue or suggest a change in the documentation.
labels: ["Documentation","Casting"]
body:
- type: markdown
attributes:
value: |
# Thank you for opening a documentation change request.
The [fcast](https://github.com/futo-org/fcast) issue tracker is reserved for issues relating to the FCast. Use the `Documentation` issue type to report problems with the documentation in our code repositories, inside the application, or on [https://fcast.org](https://fcast.org)
Technical writers monitor this issue type, so report FCast bugs or feature requests with the `Bug report` or `Feature Request` issue types instead to get engineering attention.
For general usage questions, please see: [The Official FUTO FCast Zulip Channel](https://chat.futo.org/#narrow/stream/67-FCast)
- type: textarea
id: fcast-affected-pages
attributes:
label: Affected Pages
description: |
Link to or describe the pages relevant to your documentation change request.
placeholder:
value:
validations:
required: false
- type: textarea
id: fcast-problem
attributes:
label: What is the docs issue?
description: What problems or suggestions do you have about the documentation?
placeholder:
value:
validations:
required: true
- type: textarea
id: fcast-proposal
attributes:
label: Proposal
description: What documentation changes would fix this issue and where would you expect to find them? Are one or more page headings unclear? Do one or more pages need additional context, examples, or warnings? Do we need a new page or section dedicated to a specific topic? Your ideas help us understand what you and other users need from our documentation and how we can improve the content.
placeholder:
value:
validations:
required: false
- type: textarea
id: fcast-references
attributes:
label: References
description: |
Are there any other open or closed GitLab/GitHub issues related to the problem or solution you described? If so, list them below. For example:
```
- #11
```
placeholder:
value:
validations:
required: false
- type: markdown
attributes:
value: |
**Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue.

View file

@ -0,0 +1,56 @@
name: Feature Request
description: Suggest a new feature or other enhancement.
labels: ["Enhancement","Casting"]
body:
- type: markdown
attributes:
value: |
# Thank you for opening a feature request.
The [fcast](https://github.com/futo-org/fcast) issue tracker is reserved for issues relating to the FCast. Use the `Documentation` issue type to report problems with the documentation in our code repositories, inside the application, or on [https://fcast.org](https://fcast.org)
For discussion related to enhancements, please see: [The FUTO FCast Zulip Channel](https://chat.futo.org/#narrow/stream/67-FCast)
- type: textarea
id: fcast-use-case
attributes:
label: Use Cases
description: |
In order to properly evaluate a feature request, it is necessary to understand the use cases for it. Please describe below the _end goal_ you are trying to achieve that has led you to request this feature. Please keep this section focused on the problem and not on the suggested solution.
placeholder:
value:
validations:
required: true
- type: textarea
id: fcast-proposal
attributes:
label: Proposal
description: |
If you have an idea for a way to address the problem via a change to FCast features, please describe it below.
In this section, it's helpful to include specific examples of how what you are suggesting might look in the application, this allows us to understand the full picture of what you are proposing. If you're not sure of some details, don't worry! When we evaluate the feature request we may suggest modifications as necessary to work within the design constraints of the Grayjay Core Application.
placeholder:
value:
validations:
required: false
- type: textarea
id: fcast-references
attributes:
label: References
description: |
Are there any other GitHub issues, whether open or closed, that are related to the problem you've described above or to the suggested solution? If so, please create a list below that mentions each of them. For example:
```
- #10
```
placeholder:
value:
validations:
required: false
- type: markdown
attributes:
value: |
**Note:** If the submit button is disabled and you have filled out all required fields, please check that you did not forget a **Title** for the issue.