docs: make issue forms user-friendly (drop engine/component jargon)#19
Merged
Conversation
Regular users can't answer "Engine (deepfilternet/bandit/demucs)" or pick an internal "Component (core/cli/cloud/...)", and the quality form's engine options (BandIt Plus, Demucs mdx_q) aren't even what ships now. Rewrites all three forms in plain language: - "Where did this happen?" with friendly options (Browser extension / CLI / Desktop app / Website / Docs / Not sure) instead of the Component dropdown. - Removes the freeform "Engine" question from the bug form entirely. - Quality form: replaces the engine dropdown with "Where did you use Sukoon?" (which implies the engine, no jargon) and plainer problem-kind wording. - Feature form: friendly "Which part of Sukoon?" and a single ad-principle check (dropped the contributor-only sukoon-core checkbox). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The issue forms ask regular users things only a maintainer could answer:
deepfilternet / bandit / demucs) and an internal Component dropdown (core / cli / cloud / …).BandIt Plus,Demucs mdx_q) that aren't even shipped anymore.Changes (plain language, no jargon)
sukoon-corecheckbox.All four templates validated as well-formed YAML.
🤖 Generated with Claude Code