Collaborator开发者贡献指南从bun run dev到第一个PR以及FSL许可下如何参与开源【免费下载链接】collab-publicCollaborator is a place to create with agents.项目地址: https://gitcode.com/gh_mirrors/co/collab-public这是一份面向新手的Collaborator 开源贡献指南。Collaborator 是一个 AI Agent 桌面协作工具终端、上下文文件和运行中的代码全部排布在一张无限画布上让你和 Agent 并排工作。本文将带你用bun run dev跑起本地开发环境、提交第一个 Pull RequestPR并讲清楚项目采用的 FSL-1.1-ALv2 许可证下你如何合规地参与开源贡献。认识 CollaboratorAI Agent 画布协作环境在动手写代码前先花 1 分钟了解项目定位这有助于你判断我该从哪里贡献无限画布Canvas可平移、缩放的点阵网格双击空白处即可创建终端 tile多工作区导航器左侧文件树 工作区切换器支持 CmdK 搜索四类 tile终端、Markdown 笔记、代码编辑器、图片查看器技术栈Electron 40 React 19 Tailwind CSS 4 electron-vite终端由 node-pty sidecar 驱动完整的界面与数据结构说明见 README.md 的 Specification 章节设计决策文档在 docs/superpowers/specs/。环境准备Node.js 22 Bun 一步到位Collaborator 桌面端位于 collab-electron/ 目录贡献前需要安装两个运行时依赖版本要求安装建议Node.js22 及以上macOS 用 Homebrew 最省事Bun最新稳定版负责依赖安装与脚本运行平台提示Windows 推荐 PowerShell 7WSL2 功能需要至少一个已安装的发行版Linux 可从发行版源或官方安装器获取。三步启动本地开发git clone → bun install → bun run dev在 collab-electron/package.json 中可以看到dev脚本实际执行bun ./scripts/dev.mjs它会调用 electron-vite 启动带热重载的开发环境Windows 上自动走 scripts/dev.ps1 分支。git clone https://gitcode.com/gh_mirrors/co/collab-public cd collab-public/collab-electron bun install bun run dev执行bun run dev后Electron 窗口会打开支持热重载——改完前端代码几乎即时生效非常适合调试 collab-electron/src/windows/shell/ 这类画布渲染逻辑。提示bun install触发 scripts/postinstall.mjs 会自动执行electron-rebuild重新编译 node-pty 原生模块首次安装稍慢属正常现象。用 bun test 验证你的改动项目使用 Bun 内置测试框架测试文件与源码同目录如 collab-electron/src/main/files.test.ts、collab-electron/src/main/sidecar/ring-buffer.test.ts。提交 PR 前务必在本地跑通bun test需要打生产包自测时可以运行bun run build或bun run package:unsigned生成未签名的安装包。提交第一个 PR 的 4 个步骤贡献流程在 CONTRIBUTING.md 中有官方定义浓缩如下Fork 并建分支从main分支切出你的 feature 分支做改动涉及逻辑变更时请附带测试开 PR 到main保持 PR 聚焦单一改动多个不相关变更请拆成多个 PR报告 Bug 时写清复现步骤、预期 vs 实际行为、macOS 版本与 Collaborator 版本 新手友好入口UI 文案修正、文件树排序逻辑collab-electron/packages/components/src/TreeView/、共享工具函数collab-electron/packages/shared/src/都是风险低、易验证的切入点。CLA 签署第一个 PR 的必经关卡所有贡献者在 PR 被合并前必须签署贡献者许可协议CLA.md。操作非常轻首次开 PR 时CLA bot 会自动检查签署状态未签署时只需在 PR 下评论I have read the Contributor License Agreement (CLA) and hereby sign the.评论后签名自动记录可再评论cla-bot check触发重新校验CLA 本质是授予项目方一份永久、免费的版权/专利许可并不改变你使用自己贡献代码的其他权利。FSL-1.1-ALv2理解许可证的边界Collaborator 采用 LICENSE.md 中的Functional Source LicenseFSL-1.1-ALv2贡献代码同样适用该许可。对参与者的关键结论问题答案能自由使用、修改、分发吗✅ 可以但不得用于竞争性用途什么是竞争性用途将软件或功能实质相似的产品作为商业产品/服务提供给他人替代本项目哪些用途明确允许内部使用、非商业教育、非商业研究、面向许可用户的专业服务以后会变宽松吗✅ 发布满 2 年后自动不可撤销地转为 Apache License 2.0再分发要注意什么必须附带许可证条款不得删除版权声明简单说学习、自用、二次开发、给客户做服务都没问题直接拿去做一个同质竞品收费则不行。两到两年后项目将整体转入 Apache 2.0届时限制进一步解除。贡献前快速自检清单Node.js 22 与 Bun 已安装bun run dev能打开窗口bun test全部通过PR 只包含一个聚焦的改动Bug 类 issue 附带复现步骤与版本信息PR 下已按提示完成 CLA 签名照着这份 Collaborator 开发者贡献指南走完你的第一个 PR 应该已经在 review 队列里了。祝你在无限画布上和 Agent 们并肩写代码玩得开心【免费下载链接】collab-publicCollaborator is a place to create with agents.项目地址: https://gitcode.com/gh_mirrors/co/collab-public创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考