npm - sinapse-ai - Versions diffs - 5.0.8 → 6.0.1 - Mend

sinapse-ai 5.0.8 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (660) hide show

package/docs/zh/guides/contributing-squads.md DELETED Viewed

@@ -1,250 +0,0 @@
-# Squad贡献指南
-> **EN** | **ZH-CN** | [PT](../pt/guides/contributing-squads.md) | [ES](../es/guides/contributing-squads.md)
----
-如何向SINAPSE生态系统贡献Squad。
-## 概述
-有两种方式与社区共享你的Squad：
-1. **sinapse-squads Repository** - GitHub上的免费开源Squad
-2. **SINAPSE Marketplace** - 通过SINAPSE API的高级Squad
-## 质量标准
-所有贡献的Squad必须符合这些标准：
-### 必需
-| 要求 | 描述 |
-|------|------|
-| **有效的清单** | `squad.yaml` 通过JSON Schema验证 |
-| **文档** | README.md包含使用说明 |
-| **许可证** | 开源许可证（MIT、Apache 2.0等） |
-| **SINAPSE兼容性** | `sinapse.minVersion: "2.1.0"` 或更高 |
-| **Task优先架构** | Task作为主要入口点 |
-### 推荐
-| 建议 | 描述 |
-|------|------|
-| **示例** | README中的使用示例 |
-| **测试** | 关键功能的单元测试 |
-| **变更日志** | 版本历史文档 |
-| **故障排除** | 常见问题和解决方案 |
-## 命名约定
-### Squad名称
-- 使用 `kebab-case`: `my-awesome-squad`
-- 具有描述性: `etl-data-pipeline` 而不是 `data1`
-- 避免通用名称: `helper-squad` 太模糊
-- 名称中不包含版本号: `my-squad` 而不是 `my-squad-v2`
-### 前缀 (slashPrefix)
-`squad.yaml` 中的 `slashPrefix` 决定命令前缀：
-```yaml
-slashPrefix: etl  # 命令变为 *etl-extract, *etl-transform
-```
-选择唯一的、短的前缀（2-5个字符）。
-## 清单要求
-### 必需字段
-```yaml
-# 这些字段是必需的
-name: my-squad
-version: 1.0.0              # 语义版本控制
-description: 此Squad的功能说明
-sinapse:
-  minVersion: "2.1.0"
-  type: squad
-components:
-  agents: []                # 至少一个agent或task
-  tasks: []
-```
-### 推荐字段
-```yaml
-# 这些字段是推荐的
-author: Your Name <email@example.com>
-license: MIT
-slashPrefix: my
-tags:
-  - relevant
-  - keywords
-dependencies:
-  node: []
-  python: []
-  squads: []
-```
-## 文档要求
-### README.md结构
-```markdown
-# Squad名称
-简短描述（1-2句）。
-## 安装
-如何安装/添加此Squad。
-## 用法
-基本使用示例。
-## 命令
-| 命令 | 描述 |
-|------|------|
-| *cmd1 | 它的作用 |
-| *cmd2 | 它的作用 |
-## 配置
-任何配置选项。
-## 示例
-详细的使用示例。
-## 故障排除
-常见问题和解决方案。
-## 许可证
-许可证信息。
-```
-## 发布到sinapse-squads
-### 前提条件
-1. GitHub账户
-2. Squad已验证: `*validate-squad --strict`
-3. 唯一的Squad名称（检查现有Squad）
-### 步骤
-```bash
-# 1. 验证你的Squad
-@squad-creator
-*validate-squad my-squad --strict
-# 2. 发布（创建PR）
-*publish-squad ./squads/my-squad
-```
-这将：
-1. Fork `SinapseAI/sinapse-squads` （如需要）
-2. 用你的Squad创建分支
-3. 开启审查PR
-### 审查过程
-1. **自动检查** - Schema验证、结构检查
-2. **维护者审查** - 代码审查、质量检查
-3. **合并** - Squad添加到注册表
-时间表：通常2-5个工作日。
-## 发布到SINAPSE Marketplace
-### 前提条件
-1. SINAPSE账户
-2. 配置API令牌
-3. Squad已验证
-### 步骤
-```bash
-# 1. 配置令牌
-export SINAPSE_API_TOKEN="your-token"
-# 2. 同步到marketplace
-@squad-creator
-*sync-squad-sinapse ./squads/my-squad --public
-```
-### 可见性选项
-| 标志 | 效果 |
-|------|------|
-| `--private` | 仅对你的工作区可见 |
-| `--public` | 对所有人可见 |
-## 更新已发布的Squad
-### 版本号提升
-遵循语义版本控制：
-- **MAJOR** (1.0.0 → 2.0.0): 破坏性改变
-- **MINOR** (1.0.0 → 1.1.0): 新特性，向后兼容
-- **PATCH** (1.0.0 → 1.0.1): Bug修复
-### 更新过程
-```bash
-# 1. 更新squad.yaml中的版本
-# 2. 更新CHANGELOG.md
-# 3. 验证
-*validate-squad my-squad --strict
-# 4. 重新发布
-*publish-squad ./squads/my-squad
-# 或
-*sync-squad-sinapse ./squads/my-squad
-```
-## 行为准则
-### 应该做的
-- 提供清晰、准确的文档
-- 发布前测试你的Squad
-- 对问题和反馈做出回应
-- 保持依赖项最少
-- 遵循SINAPSE约定
-### 不应该做的
-- 包含恶意代码
-- 在代码中存储凭据
-- 未经归属复制他人的工作
-- 使用冒犯性的名称或内容
-- 用测试Squad垃圾邮件注册表
-## 获得帮助
-- **问题**: [GitHub讨论](https://github.com/SinapseAI/sinapse-ai/discussions)
-- **问题**: [问题跟踪器](https://github.com/SinapseAI/sinapse-ai/issues)
-- **指南**: 本文档
-## 相关资源
-- [Squad开发指南](./squads-guide.md)
-- [Squad迁移指南](./squad-migration.md)
-- [sinapse-squads Repository](https://github.com/SinapseAI/sinapse-squads)
----
-**版本:** 1.0.0 | **更新:** 2025-12-26 | **Story:** SQS-8

package/docs/zh/guides/development-setup.md DELETED Viewed

@@ -1,384 +0,0 @@
-# 开发设置指南
-> **[EN](../../guides/development-setup.md)** | **[PT](../../pt/guides/development-setup.md)** | **[ES](../../es/guides/development-setup.md)** | **ZH**
----
-为想要为 SINAPSE 项目做出贡献的开发者提供的完整指南。
-**版本：** 1.0.0
-**最后更新：** 2026-01-29
----
-## 目录
-1. [先决条件](#先决条件)
-2. [Fork 和克隆](#fork-和克隆)
-3. [环境设置](#环境设置)
-4. [项目结构](#项目结构)
-5. [运行测试](#运行测试)
-6. [添加新代理](#添加新代理)
-7. [创建新任务](#创建新任务)
-8. [创建新工作流](#创建新工作流)
-9. [代码标准](#代码标准)
-10. [PR 和代码审查流程](#pr-和代码审查流程)
-11. [调试和故障排除](#调试和故障排除)
----
-## 先决条件
-开始前，请确保已安装以下软件：
-| 工具           | 最低版本 | 检查命令     | 目的         |
-| -------------- | -------- | ------------ | ------------ |
-| **Node.js**    | 18.0.0   | `node --version` | JavaScript 运行时 |
-| **npm**        | 9.0.0    | `npm --version`  | 包管理器     |
-| **Git**        | 2.30+    | `git --version`  | 版本控制     |
-| **GitHub CLI** | 2.0+     | `gh --version`   | GitHub 操作  |
-### 推荐工具
-| 工具                 | 目的                                 |
-| -------------------- | ------------------------------------ |
-| **Claude Code**      | 与 SINAPSE 代理进行 AI 驱动的开发       |
-| **VS Code / Cursor** | 带 SINAPSE 集成的 IDE                   |
-| **Docker Desktop**   | MCP 服务器和容器化工具               |
-### 安装先决条件
-**macOS（Homebrew）：**
-```bash
-# 安装 Node.js
-brew install node@18
-# 安装 GitHub CLI
-brew install gh
-# 认证 GitHub CLI
-gh auth login
-```
-**Windows（Chocolatey）：**
-```bash
-# 安装 Node.js
-choco install nodejs-lts
-# 安装 GitHub CLI
-choco install gh
-# 认证 GitHub CLI
-gh auth login
-```
-**Linux（Ubuntu/Debian）：**
-```bash
-# 通过 NodeSource 安装 Node.js
-curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
-sudo apt-get install -y nodejs
-# 安装 GitHub CLI
-sudo apt install gh
-# 认证 GitHub CLI
-gh auth login
-```
----
-## Fork 和克隆
-### 第 1 步：Fork 仓库
-1. 导航至 [github.com/SinapseAI/sinapse-ai](https://github.com/SinapseAI/sinapse-ai)
-2. 点击右上角的 **Fork** 按钮
-3. 选择您的 GitHub 账户作为目标
-### 第 2 步：克隆您的 Fork
-```bash
-# 克隆您的 fork
-git clone https://github.com/YOUR_USERNAME/sinapse-ai.git
-cd sinapse-ai
-# 添加上游远程
-git remote add upstream https://github.com/SinapseAI/sinapse-ai.git
-# 验证远程
-git remote -v
-```
-### 第 3 步：保持更新
-```bash
-# 从上游获取最新更改
-git fetch upstream
-# 将上游 main 合并到本地 main
-git checkout main
-git merge upstream/main
-# 推送到您的 fork
-git push origin main
-```
----
-## 环境设置
-### 第 1 步：安装依赖项
-```bash
-# 安装所有依赖项
-npm install
-```
-### 第 2 步：环境变量
-在项目根目录创建 `.env` 文件（此文件被 gitignored）：
-```bash
-# AI 提供商配置
-ANTHROPIC_API_KEY=your-anthropic-api-key
-# 可选：OpenAI 备选方案
-OPENAI_API_KEY=your-openai-api-key
-# 框架设置
-NODE_ENV=development
-SINAPSE_DEBUG=false
-# 可选：MCP 配置
-SINAPSE_API_TOKEN=your-sinapse-token
-```
-### 第 3 步：验证安装
-```bash
-# 运行测试套件
-npm test
-# 检查 linting
-npm run lint
-# 检查 TypeScript
-npm run typecheck
-# 验证项目结构
-npm run validate:structure
-```
-### 第 4 步：IDE 集成（可选）
-将 SINAPSE 代理同步到您的 IDE：
-```bash
-# 同步到所有支持的 IDE
-npm run sync:ide
-# 同步到特定 IDE
-npm run sync:ide:cursor
-# 验证同步
-npm run sync:ide:validate
-```
----
-## 代码标准
-### ESLint 配置
-项目使用 ESLint 9 及平面配置：
-```bash
-# 运行 linting
-npm run lint
-# 修复自动可修复的问题
-npm run lint -- --fix
-```
-### TypeScript 配置
-```bash
-# 运行类型检查
-npm run typecheck
-```
-### Prettier 格式化
-```bash
-# 格式化所有 Markdown 文件
-npm run format
-```
-### 命名约定
-| 类型       | 约定           | 示例                  |
-| ---------- | -------------- | --------------------- |
-| **文件**   | kebab-case     | `my-component.js`     |
-| **类**     | PascalCase     | `MyComponent`         |
-| **函数**   | camelCase      | `myFunction`          |
-| **常量**   | UPPER_SNAKE    | `MAX_RETRIES`         |
-| **代理**   | kebab-case     | `dev`、`qa`、`architect` |
-| **任务**   | kebab-case     | `create-story`、`dev-build` |
-### Commit 约定
-使用 Conventional Commits：
-```bash
-# 功能
-git commit -m "feat: add new agent validation"
-# Bug 修复
-git commit -m "fix: resolve task execution error"
-# 文档
-git commit -m "docs: update development guide"
-# 维护
-git commit -m "chore: update dependencies"
-# 带范围
-git commit -m "feat(agents): add data-engineer agent"
-git commit -m "fix(tasks): handle missing input gracefully"
-```
----
-## 运行测试
-### 测试命令
-```bash
-# 运行所有测试
-npm test
-# 在监视模式下运行测试
-npm run test:watch
-# 带覆盖率报告
-npm run test:coverage
-# 健康检查测试
-npm run test:health-check
-```
-### 编写测试
-**单元测试示例：**
-```javascript
-// tests/unit/example.test.js
-const { describe, it, expect } = require('@jest/globals');
-describe('ComponentName', () => {
-  describe('methodName', () => {
-    it('should handle expected input', () => {
-      const result = myFunction('input');
-      expect(result).toBe('expected');
-    });
-    it('should throw on invalid input', () => {
-      expect(() => myFunction(null)).toThrow('Invalid input');
-    });
-  });
-});
-```
----
-## PR 和代码审查流程
-### 步骤 1：创建特性分支
-```bash
-# 从 main 创建分支
-git checkout main
-git pull upstream main
-git checkout -b feat/my-feature
-# 或用于修复
-git checkout -b fix/bug-description
-```
-### 步骤 2：运行质量检查
-```bash
-# 运行所有检查
-npm test
-npm run lint
-npm run typecheck
-```
-### 步骤 3：提交并推送
-```bash
-# 暂存更改
-git add -A
-# 使用 conventional 消息提交
-git commit -m "feat: implement my feature"
-# 推送到您的 fork
-git push origin feat/my-feature
-```
----
-## 调试和故障排除
-### 启用调试模式
-```bash
-# 设置环境变量
-export SINAPSE_DEBUG=true
-# 用调试输出运行
-npm test -- --verbose
-```
-### 常见问题
-#### 问题：本地测试失败但 CI 中通过
-**原因：** 环境差异或过时缓存
-**解决方案：**
-```bash
-# 清除 Jest 缓存
-npx jest --clearCache
-# 清除 npm 缓存
-npm cache clean --force
-# 重新安装依赖项
-rm -rf node_modules
-npm install
-```
-#### 问题：拉取更改后 ESLint 出错
-**原因：** ESLint 缓存过时
-**解决方案：**
-```bash
-# 清除 ESLint 缓存
-rm .eslintcache
-# 再次运行 lint
-npm run lint
-```
----
-_SINAPSE 开发设置指南 v1.0.0_
-_最后更新：2026-01-29_