60 lines
2.3 KiB
Markdown
60 lines
2.3 KiB
Markdown
|
# AGENTS.md
|
||
|
|
|
||
|
|
> Codex / AI coding agent 的仓库级入口。进入本仓库后，先读本文，再进入 `docs/00-ai-start-here.md`。
|
||
|
|
|
||
|
|
## 项目定位
|
||
|
|
|
||
|
|
`cmbone` 是从 `SuiDemo` 迁移而来的 Wails v3 本地桌面项目。当前目标不是继续堆功能，而是保持一个简单、清晰、初级程序员可维护的 Wails + Vue + SQLite 应用骨架。
|
||
|
|
|
||
|
|
项目当前已具备：
|
||
|
|
|
||
|
|
- Wails v3 桌面壳和前端嵌入。
|
||
|
|
- Vue 3 设置页、多语言、主题切换。
|
||
|
|
- 本地 SQLite 配置和热键表。
|
||
|
|
- 托盘菜单、快捷键、OCR 示例窗口。
|
||
|
|
|
||
|
|
## 必读顺序
|
||
|
|
|
||
|
|
每次开始工作前，按顺序读取：
|
||
|
|
|
||
|
|
1. `README.md`：了解项目运行、构建和维护约定。
|
||
|
|
2. `docs/README.md`：了解 Harness Coding 文档导航。
|
||
|
|
3. `docs/00-ai-start-here.md`：进入固定开工流程。
|
||
|
|
4. `docs/05-coding-rules.md`：确认编码纪律。
|
||
|
|
5. `docs/current-state.md`：确认当前真实状态。
|
||
|
|
6. `progress.md`：查看最近验证结果和决策。
|
||
|
|
7. 与当前任务相关的具体文档。
|
||
|
|
|
||
|
|
## 工作规则
|
||
|
|
|
||
|
|
- 只做当前任务要求的改动，不夹带重构、依赖升级或产品扩展。
|
||
|
|
- 保持 Go `1.23.0`、Wails `v3.0.0-alpha.9`、`@wailsio/runtime 3.0.0-alpha.66` 的兼容关系；不要直接升级到 latest。
|
||
|
|
- 不提交 `bin/`、`frontend/dist/`、`frontend/node_modules/` 等构建产物或依赖目录。
|
||
|
|
- 后端服务方法变更后，优先使用 `wails3 generate bindings` 重新生成 `frontend/bindings`；如果本机没有 CLI，只允许小范围手动修正并在 `progress.md` 记录原因。
|
||
|
|
- 涉及存储结构时，同步更新 `docs/04-architecture.md`、`docs/api.md`、`docs/current-state.md` 和相关任务验收。
|
||
|
|
- 提交前至少运行 `go test ./...`、`cd frontend && npm run build`、`go build -o bin/cmbone.exe .`。
|
||
|
|
|
||
|
|
## 风格
|
||
|
|
|
||
|
|
- 文档默认中文，代码标识符默认英文。
|
||
|
|
- 优先复用现有服务、组件和工具函数。
|
||
|
|
- 错误必须处理，不吞错。
|
||
|
|
- 注释只解释不明显的原因，不复述代码。
|
||
|
|
- 新增抽象必须能减少真实复杂度，否则保持直接实现。
|
||
|
|
|
||
|
|
## 验证入口
|
||
|
|
|
||
|
|
Windows 原生 PowerShell 使用：
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
.\init.ps1
|
||
|
|
```
|
||
|
|
|
||
|
|
Git Bash / WSL / macOS / Linux 使用：
|
||
|
|
|
||
|
|
```bash
|
||
|
|
./init.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
脚本会安装前端依赖、运行后端测试、构建前端、编译后端，并打印开发启动命令。
|