Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ lerna-debug.log*
node_modules
**/node_modules

# These packages share pnpm-lock.yaml. Standalone npm packages keep their own lockfile.
/package-lock.json
/OpenBitFun-Installer/package-lock.json
/src/mobile-web/package-lock.json
/tests/e2e/package-lock.json

# Build outputs - Frontend
dist
dist-ssr
Expand Down Expand Up @@ -125,3 +131,6 @@ src/apps/mobile/android/.kotlin/

# Local generated workspace output.
/output/

# Retired implementation-process notes stay local; durable docs live with their owner.
/docs/superpowers/
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ The check detects:
pnpm install
```

The pnpm workspace uses the root `pnpm-lock.yaml` as its dependency lockfile;
do not commit `package-lock.json` files for workspace packages. The standalone
`packages/dsh-acp` npm package and `src/apps/extension-host` Bun host retain their
own lockfiles and preparation commands. Keep generated Tauri `gen/` directories
and local implementation-process notes out of Git.

### Common commands

```bash
Expand Down Expand Up @@ -115,11 +121,11 @@ We welcome contributions beyond standard feature or bug-fix PRs. Examples includ

| Contribution area | Location / files | Example |
| --- | --- | --- |
| Prompts | `src/crates/assembly/core/src/agentic/agents/prompts/` | Add or refine prompts, and update related logic as needed |
| Prompts | `src/crates/assembly/agent-content/prompts/agents/` | Add or refine built-in prompts; keep selection and runtime policy in their existing owners |
| Tools | `src/crates/assembly/core/src/agentic/tools/implementations/`, `src/crates/assembly/core/src/agentic/tools/registry.rs` | Add tool implementations and register them in the tool registry |
| Subagents | `src/crates/assembly/core/src/agentic/agents/custom_subagents/`, `src/crates/assembly/core/src/agentic/agents/registry.rs` | Add subagent implementations and register them in the subagent registry |
| Mode contributions | `src/crates/assembly/core/src/agentic/agents/*_mode.rs`, `src/crates/assembly/core/src/agentic/agents/prompts/*_mode.md`, `src/web-ui/src/locales/*/settings/modes.json` | Add/improve Agentic or custom modes and keep prompts + UI copy in sync |
| Scenario guides for Code Agent and AIIde | `website/src/docs/` | Add workflows, playbooks, and real-world scenario docs (or link them from `README.md`) |
| Subagents | `src/crates/assembly/core/src/agentic/agents/definitions/`, `src/crates/assembly/core/src/agentic/agents/registry/` | Add subagent definitions and register them with the owning registry |
| Mode contributions | `src/crates/assembly/core/src/agentic/agents/definitions/`, `src/crates/assembly/agent-content/prompts/agents/`, `src/web-ui/src/locales/` | Keep mode policy, built-in prompts, and owning UI copy in sync |
| Playbook and scenario guides | `src/shared/interactive-capabilities/catalog.json`, owning app README | Maintain the source catalog and run `pnpm run capabilities:generate`; `website/` consumes the generated catalog |

### Before you start

Expand Down Expand Up @@ -175,7 +181,7 @@ Common local checks:
| Repository metadata or GitHub config | `pnpm run check:repo-hygiene && pnpm run check:github-config && git diff --check` |
| Frontend runtime or UI | `pnpm run check:web`, plus the nearest focused test when behavior changed |
| Mobile web | `pnpm --dir src/mobile-web run type-check` |
| Rust shared runtime or services | `cargo check --workspace`, plus a focused `cargo test` when behavior changed |
| Rust shared runtime or services | Follow the nearest module `AGENTS.md`: one package/test target and the minimum required features |
| Desktop/Tauri integration | `cargo check -p openbitfun-desktop` |
| i18n resources or contract | use the matching i18n row in `AGENTS.md` |

Expand Down
15 changes: 10 additions & 5 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ pnpm run check:build-prereqs -- --fix # 尝试自动修复缺失的前置依赖
pnpm install
```

pnpm 工作区统一使用根目录的 `pnpm-lock.yaml`,不要为工作区包提交
`package-lock.json`。独立的 `packages/dsh-acp` npm 包与
`src/apps/extension-host` Bun 宿主保留各自的锁文件和准备命令。
Tauri 生成的 `gen/` 目录以及本地实施过程记录不进入 Git。

### 常用命令

```bash
Expand Down Expand Up @@ -105,11 +110,11 @@ DevTools;`Cmd/Ctrl + Shift + I` 切换 OpenBitFun 元素检查器,`Cmd/Ctrl

| 贡献方向 | 位置/文件 | 示例说明 |
| --- | --- | --- |
| Prompts | `src/crates/assembly/core/src/agentic/agents/prompts/` | 新增或优化提示词,并按需更新相关逻辑 |
| Prompts | `src/crates/assembly/agent-content/prompts/agents/` | 新增或优化内置提示词;选择逻辑与运行时策略仍由现有模块负责 |
| Tools | `src/crates/assembly/core/src/agentic/tools/implementations/`、`src/crates/assembly/core/src/agentic/tools/registry.rs` | 新增工具实现,并在工具注册表中注册 |
| Subagents | `src/crates/assembly/core/src/agentic/agents/custom_subagents/`、`src/crates/assembly/core/src/agentic/agents/registry.rs` | 新增子代理实现,并在子代理注册表中注册 |
| 模式贡献 | `src/crates/assembly/core/src/agentic/agents/*_mode.rs`、`src/crates/assembly/core/src/agentic/agents/prompts/*_mode.md`、`src/web-ui/src/locales/*/settings/modes.json` | 新增/优化 Agentic 或自定义 Agent 模式的逻辑与提示词,并同步前端模式文案 |
| Code Agent 与 AIIde 场景指南 | `website/src/docs/` | 补充流程、playbook 与真实场景说明(或从 `README.md` 链接) |
| Subagents | `src/crates/assembly/core/src/agentic/agents/definitions/`、`src/crates/assembly/core/src/agentic/agents/registry/` | 新增子代理定义,并在所属注册表中注册 |
| 模式贡献 | `src/crates/assembly/core/src/agentic/agents/definitions/`、`src/crates/assembly/agent-content/prompts/agents/`、`src/web-ui/src/locales/` | 同步模式策略、内置提示词及所属界面文案 |
| Playbook 与场景指南 | `src/shared/interactive-capabilities/catalog.json`、所属应用 README | 维护源目录并运行 `pnpm run capabilities:generate`;`website/` 消费生成的目录 |

### 开始前

Expand Down Expand Up @@ -161,7 +166,7 @@ Repository Object Sizes 检查会拒绝超过 5 MiB 的 Git 文件对象,包
| 仓库元信息或 GitHub 配置 | `pnpm run check:repo-hygiene && pnpm run check:github-config && git diff --check` |
| 前端运行时或 UI | `pnpm run check:web`;行为变化时再加最近的 focused test |
| Mobile web | `pnpm --dir src/mobile-web run type-check` |
| Rust 共享 runtime 或 services | `cargo check --workspace`;行为变化时再加 focused `cargo test` |
| Rust 共享 runtime 或 services | 遵循最近模块的 `AGENTS.md`,选择单个包/测试目标和最小所需 feature |
| Desktop/Tauri 集成 | `cargo check -p openbitfun-desktop` |
| i18n 资源或契约 | 使用 `AGENTS.md` 中匹配的 i18n 验证行 |

Expand Down
Loading
Loading