opc-agent 4.2.0 → 4.2.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.
- package/.opc/memory.db +0 -0
- package/COMPETITIVE-GAP.md +92 -92
- package/CONTRIBUTING.md +36 -36
- package/README.md +290 -290
- package/README.zh-CN.md +269 -269
- package/STUDIO-REWRITE-TASK.md +76 -0
- package/dist/channels/telegram.d.ts +5 -0
- package/dist/channels/telegram.d.ts.map +1 -1
- package/dist/channels/telegram.js +108 -0
- package/dist/channels/telegram.js.map +1 -1
- package/dist/channels/voice.d.ts +71 -97
- package/dist/channels/voice.d.ts.map +1 -1
- package/dist/channels/voice.js +369 -347
- package/dist/channels/voice.js.map +1 -1
- package/dist/channels/web.d.ts.map +1 -1
- package/dist/channels/web.js +8 -2
- package/dist/channels/web.js.map +1 -1
- package/dist/channels/wechat.js +6 -6
- package/dist/cli/chat.d.ts +4 -1
- package/dist/cli/chat.d.ts.map +1 -1
- package/dist/cli/chat.js +680 -73
- package/dist/cli/chat.js.map +1 -1
- package/dist/cli/setup.js +1 -1
- package/dist/cli/setup.js.map +1 -1
- package/dist/cli.js +373 -280
- package/dist/cli.js.map +1 -1
- package/dist/core/a2a-http.d.ts +75 -0
- package/dist/core/a2a-http.d.ts.map +1 -0
- package/dist/core/a2a-http.js +217 -0
- package/dist/core/a2a-http.js.map +1 -0
- package/dist/core/a2a.d.ts +2 -0
- package/dist/core/a2a.d.ts.map +1 -1
- package/dist/core/a2a.js +6 -1
- package/dist/core/a2a.js.map +1 -1
- package/dist/core/agent.d.ts +1 -0
- package/dist/core/agent.d.ts.map +1 -1
- package/dist/core/agent.js +3 -0
- package/dist/core/agent.js.map +1 -1
- package/dist/core/gateway-registry.d.ts +116 -0
- package/dist/core/gateway-registry.d.ts.map +1 -0
- package/dist/core/gateway-registry.js +280 -0
- package/dist/core/gateway-registry.js.map +1 -0
- package/dist/core/model-recommender.d.ts +40 -0
- package/dist/core/model-recommender.d.ts.map +1 -0
- package/dist/core/model-recommender.js +186 -0
- package/dist/core/model-recommender.js.map +1 -0
- package/dist/core/priority-queue.d.ts +100 -0
- package/dist/core/priority-queue.d.ts.map +1 -0
- package/dist/core/priority-queue.js +181 -0
- package/dist/core/priority-queue.js.map +1 -0
- package/dist/core/runtime.d.ts.map +1 -1
- package/dist/core/runtime.js +192 -22
- package/dist/core/runtime.js.map +1 -1
- package/dist/deploy/index.js +56 -56
- package/dist/doctor.d.ts +1 -0
- package/dist/doctor.d.ts.map +1 -1
- package/dist/doctor.js +155 -10
- package/dist/doctor.js.map +1 -1
- package/dist/index.d.ts +10 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +24 -13
- package/dist/index.js.map +1 -1
- package/dist/memory/deepbrain.d.ts +1 -1
- package/dist/memory/deepbrain.d.ts.map +1 -1
- package/dist/memory/deepbrain.js +95 -4
- package/dist/memory/deepbrain.js.map +1 -1
- package/dist/memory/evolve-engine.d.ts +113 -0
- package/dist/memory/evolve-engine.d.ts.map +1 -0
- package/dist/memory/evolve-engine.js +549 -0
- package/dist/memory/evolve-engine.js.map +1 -0
- package/dist/memory/index.d.ts +2 -0
- package/dist/memory/index.d.ts.map +1 -1
- package/dist/memory/index.js +3 -1
- package/dist/memory/index.js.map +1 -1
- package/dist/memory/sqlite-store.d.ts +40 -0
- package/dist/memory/sqlite-store.d.ts.map +1 -0
- package/dist/memory/sqlite-store.js +269 -0
- package/dist/memory/sqlite-store.js.map +1 -0
- package/dist/memory/user-profiler.d.ts +8 -0
- package/dist/memory/user-profiler.d.ts.map +1 -1
- package/dist/memory/user-profiler.js +89 -0
- package/dist/memory/user-profiler.js.map +1 -1
- package/dist/scheduler/cron-engine.d.ts.map +1 -1
- package/dist/scheduler/cron-engine.js +3 -36
- package/dist/scheduler/cron-engine.js.map +1 -1
- package/dist/scheduler/proactive.d.ts +62 -0
- package/dist/scheduler/proactive.d.ts.map +1 -0
- package/dist/scheduler/proactive.js +185 -0
- package/dist/scheduler/proactive.js.map +1 -0
- package/dist/skills/auto-learn.d.ts.map +1 -1
- package/dist/skills/auto-learn.js +65 -11
- package/dist/skills/auto-learn.js.map +1 -1
- package/dist/skills/builtin/index.d.ts.map +1 -1
- package/dist/skills/builtin/index.js +163 -30
- package/dist/skills/builtin/index.js.map +1 -1
- package/dist/skills/types.d.ts +1 -1
- package/dist/skills/types.d.ts.map +1 -1
- package/dist/skills/types.js +1 -0
- package/dist/skills/types.js.map +1 -1
- package/dist/studio/server.d.ts +1 -0
- package/dist/studio/server.d.ts.map +1 -1
- package/dist/studio/server.js +148 -17
- package/dist/studio/server.js.map +1 -1
- package/dist/studio-ui/index.html +867 -2630
- package/dist/ui/components.js +105 -105
- package/examples/README.md +22 -22
- package/examples/basic-agent.ts +90 -90
- package/examples/brain-integration.ts +71 -71
- package/examples/multi-channel.ts +74 -74
- package/install.ps1 +127 -127
- package/install.sh +154 -154
- package/models.json +164 -164
- package/package.json +5 -2
- package/scripts/install.ps1 +31 -31
- package/scripts/install.sh +40 -40
- package/templates/ecommerce-assistant/README.md +45 -45
- package/templates/ecommerce-assistant/oad.yaml +47 -47
- package/templates/tech-support/README.md +43 -43
- package/templates/tech-support/oad.yaml +45 -45
package/.opc/memory.db
ADDED
|
Binary file
|
package/COMPETITIVE-GAP.md
CHANGED
|
@@ -1,92 +1,92 @@
|
|
|
1
|
-
# OPC vs OpenClaw vs Hermes — 体验差距对照表
|
|
2
|
-
|
|
3
|
-
## 状态说明
|
|
4
|
-
- ✅ OPC 已有且不差于竞品
|
|
5
|
-
- 🟡 OPC 有但不如竞品
|
|
6
|
-
- ❌ OPC 缺失,竞品有
|
|
7
|
-
- 🔵 OPC 独有优势
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## 一、安装 & 初始化
|
|
12
|
-
|
|
13
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
14
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
15
|
-
| 1 | 一行安装 | `npx openclaw@latest init` | `curl \| sh` one-liner | `npm i -g opc-agent && opc init` | 🟡 两步 vs 一步 | P1 |
|
|
16
|
-
| 2 | 本地模型支持 | ✅ 支持 Ollama | ✅ 支持 | ✅ v4.1.4 Ollama-first | ✅ | - |
|
|
17
|
-
| 3 | 智能模型推荐 | ❌ 手动选 | ❌ 手动选 | ✅ 硬件检测 + 分级推荐 | 🔵 领先 | - |
|
|
18
|
-
| 4 | Setup Wizard | 交互式向导 | `hermes setup` 向导 | 交互式模板+LLM选择 | ✅ | - |
|
|
19
|
-
| 5 | 迁移工具 | - | 从 OpenClaw 迁移 | ❌ 无迁移工具 | ❌ | P3 |
|
|
20
|
-
| 6 | Doctor 诊断 | ❌ 无 | ❌ 无 | ✅ `opc doctor` 11项检查 | 🔵 领先 | - |
|
|
21
|
-
| 7 | `npx opc-agent init` 一行启动 | - | - | ❌ 需要先全局安装 | 🟡 | P1 |
|
|
22
|
-
|
|
23
|
-
## 二、自主学习 & 技能进化
|
|
24
|
-
|
|
25
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
26
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
27
|
-
| 8 | Agent 自写 Skill | ✅ AgentSkills | ✅ 自动创建 Skill MD | ❌ 代码未实现 | ❌ 关键差距 | P0 |
|
|
28
|
-
| 9 | 学习触发条件 | 自动 | 5步闭环(execute→evaluate→extract→refine→retrieve) | ❌ | ❌ | P0 |
|
|
29
|
-
| 10 | Skill 格式标准 | AgentSkills | agentskills.io MD | 无标准 | ❌ | P0 |
|
|
30
|
-
| 11 | 预置 Skill 数量 | 100+ ClawHub | 40+ bundled | 12 模板 | 🟡 | P2 |
|
|
31
|
-
| 12 | Skill 市场 | ClawHub | 社区共享 | ❌ 无 | ❌ | P3 |
|
|
32
|
-
| 13 | 知识进化(evolve) | ❌ | ❌ | ✅ DeepBrain evolve 架构 | 🔵 领先 | - |
|
|
33
|
-
| 14 | 多层知识体系 | ❌ | ❌ | ✅ 行业→岗位→工位→Agent | 🔵 领先 | - |
|
|
34
|
-
|
|
35
|
-
## 三、用户建模 & 记忆
|
|
36
|
-
|
|
37
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
38
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
39
|
-
| 15 | USER.md 用户画像 | Workspace MD | ✅ USER.md + Honcho | ❌ 无 | ❌ | P1 |
|
|
40
|
-
| 16 | SOUL.md 人格 | ✅ | ❌ | ✅ | ✅ | - |
|
|
41
|
-
| 17 | 持久记忆 | SQLite + Memory | SQLite + FTS5 | FileBackedStore JSON | 🟡 | P2 |
|
|
42
|
-
| 18 | 对话历史搜索 | ✅ | FTS5 全文搜索 | ❌ | ❌ | P2 |
|
|
43
|
-
|
|
44
|
-
## 四、渠道 & 交互
|
|
45
|
-
|
|
46
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
47
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
48
|
-
| 19 | 多渠道(TG/Discord/Slack) | ✅ 全部 | ✅ TG/Discord/Slack | ✅ 代码有 | ✅ | - |
|
|
49
|
-
| 20 | Web UI 聊天 | ✅ | ✅ | ✅ | ✅ | - |
|
|
50
|
-
| 21 | Studio 管理面板 | 无(CLI only) | 无(CLI only) | ✅ OPC Studio | 🔵 领先 | - |
|
|
51
|
-
| 22 | CLI 对话模式 | ❌ | ✅ `hermes chat` | ❌ | 🟡 | P2 |
|
|
52
|
-
|
|
53
|
-
## 五、开发者体验
|
|
54
|
-
|
|
55
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
56
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
57
|
-
| 23 | TypeScript SDK | ❌ | ❌ | ✅ | 🔵 领先 | - |
|
|
58
|
-
| 24 | A2A 协议 | ❌ | ❌ | ✅ | 🔵 领先 | - |
|
|
59
|
-
| 25 | MCP 协议 | ✅ | ✅ | ✅ | ✅ | - |
|
|
60
|
-
| 26 | Workstation 模板 | ❌ | ❌ | ✅ 100+ 角色 | 🔵 领先 | - |
|
|
61
|
-
| 27 | `npx opc-agent` 零安装运行 | ✅ npx openclaw | ❌ | ❌ | 🟡 | P1 |
|
|
62
|
-
|
|
63
|
-
## 六、自动化 & 调度
|
|
64
|
-
|
|
65
|
-
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
66
|
-
|---|--------|----------|--------|----------|------|--------|
|
|
67
|
-
| 28 | Cron 定时任务 | ✅ Heartbeat | ❌ | ✅ cron-engine | ✅ | - |
|
|
68
|
-
| 29 | 主动触达 | ✅ Proactive | ❌ | 🟡 有 cron 但无主动逻辑 | 🟡 | P2 |
|
|
69
|
-
|
|
70
|
-
---
|
|
71
|
-
|
|
72
|
-
## 优先级行动计划
|
|
73
|
-
|
|
74
|
-
### P0 — 今天必须启动(自主学习闭环)
|
|
75
|
-
1. **#8 Agent 自写 Skill** — 实现 auto-skill-creation
|
|
76
|
-
2. **#9 学习触发条件** — 实现 5 步闭环
|
|
77
|
-
3. **#10 Skill 格式标准** — 采用 agentskills.io 兼容格式
|
|
78
|
-
|
|
79
|
-
### P1 — 今天尽量完成(安装体验 + 用户建模)
|
|
80
|
-
4. **#1/#7/#27 一行安装** — 支持 `npx opc-agent init`
|
|
81
|
-
5. **#15 USER.md 用户建模** — Agent 自动学习用户偏好
|
|
82
|
-
|
|
83
|
-
### P2 — 本周完成
|
|
84
|
-
6. **#11 更多预置 Skill** — 扩充到 40+
|
|
85
|
-
7. **#17 SQLite 持久记忆** — 替代 JSON
|
|
86
|
-
8. **#18 对话历史搜索** — FTS5
|
|
87
|
-
9. **#22 CLI 对话模式** — `opc chat`
|
|
88
|
-
10. **#29 主动触达** — Agent 主动发消息
|
|
89
|
-
|
|
90
|
-
### P3 — 后续
|
|
91
|
-
11. **#5 迁移工具** — 从 OpenClaw/Hermes 迁移
|
|
92
|
-
12. **#12 Skill 市场** — OPC Hub
|
|
1
|
+
# OPC vs OpenClaw vs Hermes — 体验差距对照表
|
|
2
|
+
|
|
3
|
+
## 状态说明
|
|
4
|
+
- ✅ OPC 已有且不差于竞品
|
|
5
|
+
- 🟡 OPC 有但不如竞品
|
|
6
|
+
- ❌ OPC 缺失,竞品有
|
|
7
|
+
- 🔵 OPC 独有优势
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 一、安装 & 初始化
|
|
12
|
+
|
|
13
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
14
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
15
|
+
| 1 | 一行安装 | `npx openclaw@latest init` | `curl \| sh` one-liner | `npm i -g opc-agent && opc init` | 🟡 两步 vs 一步 | P1 |
|
|
16
|
+
| 2 | 本地模型支持 | ✅ 支持 Ollama | ✅ 支持 | ✅ v4.1.4 Ollama-first | ✅ | - |
|
|
17
|
+
| 3 | 智能模型推荐 | ❌ 手动选 | ❌ 手动选 | ✅ 硬件检测 + 分级推荐 | 🔵 领先 | - |
|
|
18
|
+
| 4 | Setup Wizard | 交互式向导 | `hermes setup` 向导 | 交互式模板+LLM选择 | ✅ | - |
|
|
19
|
+
| 5 | 迁移工具 | - | 从 OpenClaw 迁移 | ❌ 无迁移工具 | ❌ | P3 |
|
|
20
|
+
| 6 | Doctor 诊断 | ❌ 无 | ❌ 无 | ✅ `opc doctor` 11项检查 | 🔵 领先 | - |
|
|
21
|
+
| 7 | `npx opc-agent init` 一行启动 | - | - | ❌ 需要先全局安装 | 🟡 | P1 |
|
|
22
|
+
|
|
23
|
+
## 二、自主学习 & 技能进化
|
|
24
|
+
|
|
25
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
26
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
27
|
+
| 8 | Agent 自写 Skill | ✅ AgentSkills | ✅ 自动创建 Skill MD | ❌ 代码未实现 | ❌ 关键差距 | P0 |
|
|
28
|
+
| 9 | 学习触发条件 | 自动 | 5步闭环(execute→evaluate→extract→refine→retrieve) | ❌ | ❌ | P0 |
|
|
29
|
+
| 10 | Skill 格式标准 | AgentSkills | agentskills.io MD | 无标准 | ❌ | P0 |
|
|
30
|
+
| 11 | 预置 Skill 数量 | 100+ ClawHub | 40+ bundled | 12 模板 | 🟡 | P2 |
|
|
31
|
+
| 12 | Skill 市场 | ClawHub | 社区共享 | ❌ 无 | ❌ | P3 |
|
|
32
|
+
| 13 | 知识进化(evolve) | ❌ | ❌ | ✅ DeepBrain evolve 架构 | 🔵 领先 | - |
|
|
33
|
+
| 14 | 多层知识体系 | ❌ | ❌ | ✅ 行业→岗位→工位→Agent | 🔵 领先 | - |
|
|
34
|
+
|
|
35
|
+
## 三、用户建模 & 记忆
|
|
36
|
+
|
|
37
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
38
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
39
|
+
| 15 | USER.md 用户画像 | Workspace MD | ✅ USER.md + Honcho | ❌ 无 | ❌ | P1 |
|
|
40
|
+
| 16 | SOUL.md 人格 | ✅ | ❌ | ✅ | ✅ | - |
|
|
41
|
+
| 17 | 持久记忆 | SQLite + Memory | SQLite + FTS5 | FileBackedStore JSON | 🟡 | P2 |
|
|
42
|
+
| 18 | 对话历史搜索 | ✅ | FTS5 全文搜索 | ❌ | ❌ | P2 |
|
|
43
|
+
|
|
44
|
+
## 四、渠道 & 交互
|
|
45
|
+
|
|
46
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
47
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
48
|
+
| 19 | 多渠道(TG/Discord/Slack) | ✅ 全部 | ✅ TG/Discord/Slack | ✅ 代码有 | ✅ | - |
|
|
49
|
+
| 20 | Web UI 聊天 | ✅ | ✅ | ✅ | ✅ | - |
|
|
50
|
+
| 21 | Studio 管理面板 | 无(CLI only) | 无(CLI only) | ✅ OPC Studio | 🔵 领先 | - |
|
|
51
|
+
| 22 | CLI 对话模式 | ❌ | ✅ `hermes chat` | ❌ | 🟡 | P2 |
|
|
52
|
+
|
|
53
|
+
## 五、开发者体验
|
|
54
|
+
|
|
55
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
56
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
57
|
+
| 23 | TypeScript SDK | ❌ | ❌ | ✅ | 🔵 领先 | - |
|
|
58
|
+
| 24 | A2A 协议 | ❌ | ❌ | ✅ | 🔵 领先 | - |
|
|
59
|
+
| 25 | MCP 协议 | ✅ | ✅ | ✅ | ✅ | - |
|
|
60
|
+
| 26 | Workstation 模板 | ❌ | ❌ | ✅ 100+ 角色 | 🔵 领先 | - |
|
|
61
|
+
| 27 | `npx opc-agent` 零安装运行 | ✅ npx openclaw | ❌ | ❌ | 🟡 | P1 |
|
|
62
|
+
|
|
63
|
+
## 六、自动化 & 调度
|
|
64
|
+
|
|
65
|
+
| # | 体验点 | OpenClaw | Hermes | OPC 现状 | 差距 | 优先级 |
|
|
66
|
+
|---|--------|----------|--------|----------|------|--------|
|
|
67
|
+
| 28 | Cron 定时任务 | ✅ Heartbeat | ❌ | ✅ cron-engine | ✅ | - |
|
|
68
|
+
| 29 | 主动触达 | ✅ Proactive | ❌ | 🟡 有 cron 但无主动逻辑 | 🟡 | P2 |
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 优先级行动计划
|
|
73
|
+
|
|
74
|
+
### P0 — 今天必须启动(自主学习闭环)
|
|
75
|
+
1. **#8 Agent 自写 Skill** — 实现 auto-skill-creation
|
|
76
|
+
2. **#9 学习触发条件** — 实现 5 步闭环
|
|
77
|
+
3. **#10 Skill 格式标准** — 采用 agentskills.io 兼容格式
|
|
78
|
+
|
|
79
|
+
### P1 — 今天尽量完成(安装体验 + 用户建模)
|
|
80
|
+
4. **#1/#7/#27 一行安装** — 支持 `npx opc-agent init`
|
|
81
|
+
5. **#15 USER.md 用户建模** — Agent 自动学习用户偏好
|
|
82
|
+
|
|
83
|
+
### P2 — 本周完成
|
|
84
|
+
6. **#11 更多预置 Skill** — 扩充到 40+
|
|
85
|
+
7. **#17 SQLite 持久记忆** — 替代 JSON
|
|
86
|
+
8. **#18 对话历史搜索** — FTS5
|
|
87
|
+
9. **#22 CLI 对话模式** — `opc chat`
|
|
88
|
+
10. **#29 主动触达** — Agent 主动发消息
|
|
89
|
+
|
|
90
|
+
### P3 — 后续
|
|
91
|
+
11. **#5 迁移工具** — 从 OpenClaw/Hermes 迁移
|
|
92
|
+
12. **#12 Skill 市场** — OPC Hub
|
package/CONTRIBUTING.md
CHANGED
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
Thanks for your interest in contributing!
|
|
4
|
-
|
|
5
|
-
## Getting Started
|
|
6
|
-
|
|
7
|
-
1. Fork the repo
|
|
8
|
-
2. Clone your fork
|
|
9
|
-
3. Install dependencies: `npm install`
|
|
10
|
-
4. Create a branch: `git checkout -b feat/my-feature`
|
|
11
|
-
5. Make your changes
|
|
12
|
-
6. Run tests: `npm test`
|
|
13
|
-
7. Commit: `git commit -m "feat: description"`
|
|
14
|
-
8. Push and open a PR
|
|
15
|
-
|
|
16
|
-
## Commit Convention
|
|
17
|
-
|
|
18
|
-
- `feat:` New feature
|
|
19
|
-
- `fix:` Bug fix
|
|
20
|
-
- `docs:` Documentation
|
|
21
|
-
- `test:` Tests
|
|
22
|
-
- `refactor:` Refactoring
|
|
23
|
-
- `chore:` Build/tooling
|
|
24
|
-
|
|
25
|
-
## Code Style
|
|
26
|
-
|
|
27
|
-
- TypeScript
|
|
28
|
-
- Run `npm run lint` before committing (if available)
|
|
29
|
-
|
|
30
|
-
## Questions?
|
|
31
|
-
|
|
32
|
-
Open a Discussion or Issue.
|
|
33
|
-
|
|
34
|
-
## License
|
|
35
|
-
|
|
36
|
-
By contributing, you agree that your contributions will be licensed under Apache-2.0.
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing!
|
|
4
|
+
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
1. Fork the repo
|
|
8
|
+
2. Clone your fork
|
|
9
|
+
3. Install dependencies: `npm install`
|
|
10
|
+
4. Create a branch: `git checkout -b feat/my-feature`
|
|
11
|
+
5. Make your changes
|
|
12
|
+
6. Run tests: `npm test`
|
|
13
|
+
7. Commit: `git commit -m "feat: description"`
|
|
14
|
+
8. Push and open a PR
|
|
15
|
+
|
|
16
|
+
## Commit Convention
|
|
17
|
+
|
|
18
|
+
- `feat:` New feature
|
|
19
|
+
- `fix:` Bug fix
|
|
20
|
+
- `docs:` Documentation
|
|
21
|
+
- `test:` Tests
|
|
22
|
+
- `refactor:` Refactoring
|
|
23
|
+
- `chore:` Build/tooling
|
|
24
|
+
|
|
25
|
+
## Code Style
|
|
26
|
+
|
|
27
|
+
- TypeScript
|
|
28
|
+
- Run `npm run lint` before committing (if available)
|
|
29
|
+
|
|
30
|
+
## Questions?
|
|
31
|
+
|
|
32
|
+
Open a Discussion or Issue.
|
|
33
|
+
|
|
34
|
+
## License
|
|
35
|
+
|
|
36
|
+
By contributing, you agree that your contributions will be licensed under Apache-2.0.
|