SuperAPI AI 工具集

contribute

编程与开发

查看项目

更新于 10-20 01:49

技能介绍

用途:该技能面向 Superset 开源项目贡献者,目标是把“我想修复或开发 Superset 中的某个功能”推进为符合仓库规则、可合并的 PR。如果当前检出的仓库包含 CONTRIBUTING.md、DEVELOPMENT.md 或 AGENTS.md,则这些文件具有最高权威性,应优先阅读并遵循,其优先级高于本摘要。

范围判断:对于缺陷修复、文档修改和小改进,可以直接提交 PR,无需先开 issue;对于新功能或较大改动,应先到 https://github.com/superset-sh/superset/issues/new/choose 开 issue,就实现方案达成一致后再开发;一般性问题应通过 Superset Discord 讨论,而不是开 issue。

环境配置:先检查 gh auth status,然后通过 gh repo fork superset-sh/superset --clone 进行 fork 并克隆,或在已有克隆中添加 fork 远程。推荐把克隆作为项目加入 Superset 应用,并为每个改动创建 workspace,使贡献在受管 worktree 中开发。在新的 workspace/worktree 中执行一次 ./.superset/setup.local.sh,以配置每个 workspace 的端口、应用标识、本地服务和预置开发账号,无需外部凭据,然后运行 bun run dev。只能使用 Bun,不得使用 npm/yarn/pnpm,并遵循根目录 AGENTS.md。

达到可合并状态:从 main 拉分支,每个 PR 只包含一个改动,无关发现应另开 PR。推送前依次运行 bun run lint:fix,确认 bun run lint 无报错退出(CI 对警告也会失败),再运行 bun run typecheck 和 bun run test。PR 标题必须采用 conventional commit 格式,如 feat(desktop): ...、fix(web): ...;PR 以 squash 方式合并,标题作为提交主题。需提供可运行证明:用户可见改动附截图或录屏,修复类改动附前后对比。开发桌面应用开放 CDP 以便清晰截屏,详见 CONTRIBUTING.md 中“Capturing screenshots via CDP”。勾选“Allow edits from maintainers”,非简单改动需关联 issue。

创建 PR:通过 gh pr create 面向 superset-sh/superset main 创建,如实填写 PR 模板,包括运行了什么、点击了什么、测试覆盖了什么,并把 PR URL 回报给用户。