superset-feedback

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Superset Feedback

Superset 反馈

Help the user turn their feedback about Superset into a well-formed report and submit it where they choose. Treat whatever they wrote after the command as the seed.
帮助用户将关于Superset的反馈整理为格式规范的报告,并提交至其选择的渠道。将用户在命令后输入的内容作为初始素材。

1. Gather context (best effort, never block)

1. 收集上下文信息(尽最大努力,切勿阻塞流程)

Run in parallel; skip anything that fails:
  • superset --version
    and
    uname -sm
    for the environment block
  • superset auth whoami
    for the signed-in user/org (private submissions only)
Do NOT include repository contents, terminal output, or logs unless the user explicitly agrees when asked.
For bugs, also offer (never assume):
  • Screenshot — if the bug is visual and you can capture one, offer to attach it. Evidence beats prose.
  • Diagnostics — offer to attach a diagnostics bundle (CLI version, OS, last 200 app log lines) via the
    --diagnostics
    flag. Tell the user logs can contain file paths and project names before they agree.
并行执行以下操作;若某项操作失败则跳过:
  • 执行
    superset --version
    uname -sm
    以获取环境信息块
  • 执行
    superset auth whoami
    以获取登录用户/组织信息(仅适用于私下提交场景)
除非用户明确同意,否则请勿包含仓库内容、终端输出或日志信息。
对于bug报告,额外提供(切勿自行假设):
  • 截图——若bug属于视觉类问题且可捕获截图,可主动提出附加截图。实证比文字描述更有效。
  • 诊断信息——主动提出通过
    --diagnostics
    参数附加诊断包(包含CLI版本、操作系统、最近200条应用日志)。在用户同意前,需告知其日志可能包含文件路径和项目名称。

2. Classify and draft

2. 分类并撰写报告

Classify as bug, feature request, or general feedback from their words; ask only if genuinely ambiguous. Then draft:
  • Title — one line, imperative, specific
  • What happened / What you want — 2-5 sentences in the user's voice
  • Steps to reproduce — bugs only, numbered
  • Environment — Superset version, OS (bugs only)
根据用户表述将反馈分类为bug报告功能请求一般性反馈;仅当分类确实存在歧义时才询问用户。随后撰写报告:
  • 标题——单行、祈使语气、明确具体
  • 问题描述/需求说明——以用户口吻撰写2-5句话
  • 复现步骤——仅适用于bug报告,采用编号列表
  • 环境信息——Superset版本、操作系统(仅适用于bug报告)

3. Ask where to send it

3. 询问提交渠道

Show the full draft, then ask the user (use the ask_user tool if available, otherwise a plain question) with exactly these options:
  1. Send privately to the Superset team
  2. Open a public GitHub issue
  3. Edit the draft first
  4. Cancel
Never submit anything before the user explicitly picks 1 or 2. Loop on edits.
展示完整的报告草稿,然后向用户提供以下明确选项(若有ask_user工具则使用该工具,否则直接以文字提问):
  1. 私下发送给Superset团队
  2. 创建公开GitHub议题
  3. 先编辑草稿
  4. 取消提交
在用户明确选择1或2之前,切勿提交任何内容。支持循环编辑草稿。

4. Submit

4. 提交报告

Private path:
  • If
    superset feedback --help
    exits 0, submit via stdin (note:
    --body-file=-
    with the equals sign; a space-separated
    -
    is rejected by the parser):
    bash
    superset feedback submit --type bug --title "..." --body-file=- <<'EOF'
    <drafted report>
    EOF
    Only when the user agreed to them in step 1, add
    --attach /path/to/screenshot.png
    (comma-separated paths, 10MB total) and/or
    --diagnostics
    . The submission is sent from the user's Superset account, a copy is CC'd to them, and the team replies to their account email.
  • If the CLI is missing or not logged in (
    superset auth whoami
    fails), offer
    superset auth login
    first; if declined, fall back to email: give the user a clickable mailto link (
    mailto:support@superset.sh?subject=<url-encoded title>&body=<url-encoded body>
    ) and also print the raw draft so they can copy it.
Public path:
  • Check for duplicates first:
    gh search issues -R superset-sh/superset "<key terms>" --limit 5
    . If an existing issue matches, show it and offer to comment there (
    gh issue comment
    ) instead of opening a new one — only create a fresh issue if the user confirms it's genuinely different.
  • If
    gh
    is installed and
    gh auth status
    succeeds:
    gh issue create -R superset-sh/superset --title "..." --body "..."
    (write the body via a heredoc or temp file, never inline-escape).
  • Otherwise open the prefilled form in the browser:
    https://github.com/superset-sh/superset/issues/new?title=<url-encoded>&body=<url-encoded>
    .
私下提交渠道:
  • superset feedback --help
    执行返回0,则通过标准输入提交(注意:需使用
    --body-file=-
    格式,等号不可省略;空格分隔的
    -
    会被解析器拒绝):
    bash
    superset feedback submit --type bug --title "..." --body-file=- <<'EOF'
    <撰写好的报告内容>
    EOF
    仅当用户在步骤1中同意附加相关内容时,添加
    --attach /path/to/screenshot.png
    (多个路径用逗号分隔,总大小不超过10MB)和/或
    --diagnostics
    参数。提交将通过用户的Superset账户发送,副本会抄送给用户,团队将回复至用户账户绑定的邮箱。
  • 若CLI缺失或未登录(
    superset auth whoami
    执行失败),先提示用户执行
    superset auth login
    ;若用户拒绝,则退而求其次使用邮件:向用户提供可点击的mailto链接(
    mailto:support@superset.sh?subject=<url编码的标题>&body=<url编码的报告内容>
    ),同时打印原始草稿以便用户复制。
公开提交渠道:
  • 先检查重复议题:执行
    gh search issues -R superset-sh/superset "<关键词>" --limit 5
    。若存在匹配的现有议题,展示该议题并建议用户在下方评论(执行
    gh issue comment
    )而非创建新议题——仅当用户确认该反馈确实不同时,才创建新议题。
  • 若已安装
    gh
    gh auth status
    执行成功:执行
    gh issue create -R superset-sh/superset --title "..." --body "..."
    (通过here文档或临时文件写入内容,切勿直接内联转义)。
  • 否则,在浏览器中打开预填充的表单:
    https://github.com/superset-sh/superset/issues/new?title=<url编码的标题>&body=<url编码的报告内容>

5. Confirm

5. 确认提交结果

Report back the issue URL (public) or a confirmation of what was sent and to whom (private). If anything failed, show the draft so the user's writing is never lost.
反馈公开议题的URL(公开提交场景),或确认已发送的内容及接收方(私下提交场景)。若提交失败,需展示草稿内容,确保用户的撰写内容不会丢失。