mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-06-09 15:13:32 -07:00
chore: add issue forms and expand PR template (#100)
This commit is contained in:
@@ -0,0 +1,105 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Report something that is broken or behaving incorrectly
|
||||||
|
title: "[Bug]: "
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to file a bug report! Please search [existing issues](https://github.com/ksyasuda/SubMiner/issues?q=is%3Aissue) first to avoid duplicates.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: what-happened
|
||||||
|
attributes:
|
||||||
|
label: What happened?
|
||||||
|
description: A clear description of the bug, including what you expected to happen instead.
|
||||||
|
placeholder: When I open the Yomitan popup, the overlay freezes...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Minimal, ordered steps that reliably trigger the bug.
|
||||||
|
placeholder: |
|
||||||
|
1. Launch `subminer`
|
||||||
|
2. Play a video in MPV
|
||||||
|
3. Hover a word and press ...
|
||||||
|
4. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: area
|
||||||
|
attributes:
|
||||||
|
label: Affected area
|
||||||
|
description: Which part of SubMiner is affected?
|
||||||
|
options:
|
||||||
|
- Overlay / Yomitan popup
|
||||||
|
- Anki mining
|
||||||
|
- Subtitle annotations
|
||||||
|
- Subtitle sidebar
|
||||||
|
- Immersion tracking / stats
|
||||||
|
- Launcher / CLI
|
||||||
|
- MPV plugin
|
||||||
|
- Jellyfin integration
|
||||||
|
- Jimaku integration
|
||||||
|
- AniList integration
|
||||||
|
- YouTube integration
|
||||||
|
- Character dictionary
|
||||||
|
- WebSocket / texthooker API
|
||||||
|
- Configuration
|
||||||
|
- Documentation
|
||||||
|
- Other / not sure
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating system
|
||||||
|
options:
|
||||||
|
- Linux
|
||||||
|
- macOS
|
||||||
|
- Windows
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: SubMiner version
|
||||||
|
description: Output of `subminer --version`, or the release tag / commit you are running.
|
||||||
|
placeholder: v0.15.0
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: compositor
|
||||||
|
attributes:
|
||||||
|
label: Compositor (Linux only)
|
||||||
|
description: SubMiner's overlay supports Hyprland and sway. Name yours (and version if known). Leave blank on macOS / Windows.
|
||||||
|
placeholder: Hyprland 0.55
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: mpv-version
|
||||||
|
attributes:
|
||||||
|
label: MPV version
|
||||||
|
description: Output of `mpv --version` (first line).
|
||||||
|
placeholder: mpv 0.38.0
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Logs / console output
|
||||||
|
description: |
|
||||||
|
Relevant logs. For verbose output, run `electron . --dev --log-level debug`.
|
||||||
|
This will be rendered as code automatically — no backticks needed.
|
||||||
|
render: shell
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Documentation
|
||||||
|
url: https://docs.subminer.moe
|
||||||
|
about: Setup, configuration, and feature docs — check here before filing an issue.
|
||||||
|
- name: Troubleshooting guide
|
||||||
|
url: https://docs.subminer.moe/troubleshooting
|
||||||
|
about: Common problems and fixes (Hyprland rules, MPV detection, Anki connection, etc.).
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Suggest a new feature or an improvement to an existing one
|
||||||
|
title: "[Feature]: "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for the idea! Please search [existing issues](https://github.com/ksyasuda/SubMiner/issues?q=is%3Aissue) first to avoid duplicates.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: Problem / motivation
|
||||||
|
description: What problem are you trying to solve? What is missing or frustrating today?
|
||||||
|
placeholder: When mining a card I have to manually switch to Anki because...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: proposal
|
||||||
|
attributes:
|
||||||
|
label: Proposed solution
|
||||||
|
description: Describe the feature or change you'd like to see.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: area
|
||||||
|
attributes:
|
||||||
|
label: Related area
|
||||||
|
description: Which part of SubMiner does this relate to?
|
||||||
|
options:
|
||||||
|
- Overlay / Yomitan popup
|
||||||
|
- Anki mining
|
||||||
|
- Subtitle annotations
|
||||||
|
- Subtitle sidebar
|
||||||
|
- Immersion tracking / stats
|
||||||
|
- Launcher / CLI
|
||||||
|
- MPV plugin
|
||||||
|
- Jellyfin integration
|
||||||
|
- Jimaku integration
|
||||||
|
- AniList integration
|
||||||
|
- YouTube integration
|
||||||
|
- Character dictionary
|
||||||
|
- WebSocket / texthooker API
|
||||||
|
- Configuration
|
||||||
|
- Documentation
|
||||||
|
- Other / new area
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Alternatives considered
|
||||||
|
description: Any workarounds you currently use or other approaches you've thought about.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
@@ -1,3 +1,36 @@
|
|||||||
|
<!--
|
||||||
|
Thanks for contributing to SubMiner! Fill out the sections below.
|
||||||
|
Keep it short — a couple of sentences per section is fine.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- What does this PR do and why? -->
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
<!-- Check all that apply. -->
|
||||||
|
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] New feature
|
||||||
|
- [ ] Refactor / internal
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] Other
|
||||||
|
|
||||||
|
## Related issues
|
||||||
|
|
||||||
|
<!-- e.g. "Closes #123". Delete if none. -->
|
||||||
|
|
||||||
|
## How was this tested?
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Describe verification. The default handoff gate is:
|
||||||
|
bun run typecheck && bun run test:fast && bun run test:env && bun run build && bun run test:smoke:dist
|
||||||
|
If docs-site/ changed, also: bun run docs:test && bun run docs:build
|
||||||
|
-->
|
||||||
|
|
||||||
## Checklist
|
## Checklist
|
||||||
|
|
||||||
- [ ] Added a changelog fragment in `changes/`, or this PR is labeled `skip-changelog`
|
- [ ] Added a changelog fragment, or this PR is labeled `skip-changelog` (see [`changes/README.md`](../changes/README.md))
|
||||||
|
- [ ] Docs updated in the same PR if behavior, defaults, flags, shortcuts, ports, or APIs changed
|
||||||
|
- [ ] Relevant checks pass locally (typecheck, tests, build)
|
||||||
|
|||||||
Reference in New Issue
Block a user