关于 superset-contribute
帮助开发者将 Superset 改动整理为可合并拉取请求的贡献技能。内容涵盖改动范围、仓库设置、验证命令和 PR 要求;若仓库有指导文件,则以其为准。
主要功能
- 01按改动规模选择 issue 或 PR 流程
- 02Fork 仓库并设置开发工作区
- 03使用 Bun 开发和验证
- 04运行 lint、类型检查和测试
- 05准备符合规范标题的拉取请求
适用场景
- 01准备 Superset 小型缺陷修复
- 02先确定方案再开发功能
- 03验证并提交 Superset 贡献
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ superset-sh/ skills --skill superset-contribute安装后在 Claude Code 中输入/superset-contribute确认已加载。
详细介绍
为 Superset 做贡献
帮助用户从“我想在 Superset 中修复/构建 X”走到符合仓库规则、可合并的 PR。如果检出的仓库中有 CONTRIBUTING.md / DEVELOPMENT.md / AGENTS.md,这些文件具有权威性——请阅读并优先遵循它们,而非本摘要。
1. 先确定范围
- 修复 Bug、文档、小型改进 → 直接提交 PR,无需先提 Issue
- 新功能或较大的改动 → 先在 https://github.com/superset-sh/superset/issues/new/choose 提交 Issue,确认方案后再开始开发
- 有问题 → 去 Superset Discord 提问,不要提 Issue
2. 配置环境
- 执行
gh auth status,然后 Fork 并克隆:gh repo fork superset-sh/superset --clone(或为现有克隆添加 Fork 远程仓库) - 最佳体验:将克隆的仓库作为项目添加到 Superset 应用中,并为每项改动创建一个工作区——贡献工作将在受管理的工作树中进行
- 在新的工作区/工作树中运行一次
./.superset/setup.local.sh(此脚本会配置每个工作区的端口、应用标识、本地服务和预置的开发账号——无需外部凭据),然后运行bun run dev - 仅使用 Bun——绝不要使用 npm/yarn/pnpm。阅读根目录下的
AGENTS.md并遵循其中的要求。
3. 做好合并准备
- 从
main创建分支;每个 PR 只包含一项改动——发现的无关问题应另开一个 PR - 推送前:运行
bun run lint:fix,然后确认bun run lint正常退出(CI 也会因警告而失败),再运行bun run typecheck和bun run test - PR 标题必须符合 Conventional Commits 规范(例如
feat(desktop): ...、fix(web): ...)——PR 会以标题作为提交主题进行 Squash 合并 - 提供有效性证明:所有用户可见的改动都应附上截图或录屏;修复应提供前后对比。开发版桌面应用支持 CDP,可用于清晰截图——请参阅 CONTRIBUTING.md 中的 “Capturing screenshots via CDP”
- 勾选 “Allow edits from maintainers”,并为非琐碎改动关联 Issue
4. 提交 PR
针对 superset-sh/superset 的 main 执行 gh pr create,如实填写 PR 模板(运行了什么、点击了什么、测试覆盖了哪些内容),并将 PR URL 告知用户。
评论
支持 Markdown