File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# AGENTS.md
22
3- 详细操作指南见 [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) 。
4-
53## SKILL 快速索引
64
75| 场景 | SKILL 位置 |
2018
2119AI Agent 进入仓库后,先读取 ` .quanttide/ ` 目录获取上下文。
2220
21+ ## 特殊文件
22+
23+ | 文件 | 用途 |
24+ | ------| ------|
25+ | ` AGENTS.md ` | AI Agent 工作指南(本文档) |
26+ | ` CONTRIBUTING.md ` | 贡献指南和 SKILL 维护 |
27+ | ` .quanttide/ ` | 契约事实源,配置资产和文档规范 |
28+
2329## 工作原则
2430
25311 . 最小干预:仅在用户明确请求时操作
Original file line number Diff line number Diff line change 1010
1111本项目的 AI Agent 技能存储在 ` .agents/skills/ ` 目录。
1212
13+ SKILL 维护遵循 [ Agent Skills 规范] ( https://agentskills.io/specification ) 。
14+
1315### SKILL 目录结构
1416
1517```
1820│ └── SKILL.md
1921```
2022
21- ### 创建新 SKILL
22-
23- 1 . 在 ` .agents/skills/ ` 下创建技能目录
24- 2 . 编写 ` SKILL.md ` ,包含:
25- - YAML 头:` name ` 、` description `
26- - 技能说明和使用方法
27-
2823### SKILL 格式规范
2924
3025``` yaml
@@ -34,6 +29,12 @@ description: 技能描述,说明使用场景
3429---
3530```
3631
32+ ### 创建新 SKILL
33+
34+ 1 . 在 ` .agents/skills/ ` 下创建技能目录
35+ 2 . 编写 ` SKILL.md ` ,包含 YAML 头和技能说明
36+ 3 . 参考已有 SKILL 的结构和格式
37+
3738### 同步 SKILL 到子仓库
3839
3940稳定的 SKILL 可同步到 gallery 仓库:
@@ -57,40 +58,42 @@ git push
5758
5859---
5960
60- ## 子模块操作
61+ ## .quanttide 配置维护
6162
62- ### 更新子模块
63+ ` .quanttide/ ` 目录是项目的契约事实源。
6364
64- ``` bash
65- # 查看子模块状态
66- git submodule status
65+ ### 契约文件
6766
68- # 更新所有子模块
69- git submodule update --init --recursive
67+ | 文件 | 用途 |
68+ | ------| ------|
69+ | ` .quanttide/asset/contract.yaml ` | 数字资产契约 |
70+ | ` .quanttide/docs/contract.yaml ` | 文档工程契约 |
7071
71- # 在子模块中提交并推送
72- git -C < 子模块路径> commit -m " message"
73- git -C < 子模块路径> push
74- ```
72+ ### 添加新契约
7573
76- ### 提交子模块更新
74+ 1 . 在 ` .quanttide/ ` 下创建对应分类目录
75+ 2 . 创建 ` contract.yaml ` ,包含契约说明
76+ 3 . 更新 ` .quanttide/README.md ` 添加契约索引
77+ 4 . 提交并推送
7778
78- 1 . 在子模块中提交并推送
79- 2 . 在主仓库提交子模块引用更新
79+ ### 契约格式
8080
81- ``` bash
82- git -C docs/handbook add -A
83- git -C docs/handbook commit -m " feat: update content"
84- git -C docs/handbook push
85-
86- git add docs/handbook
87- git commit -m " chore: update handbook submodule"
88- git push
81+ ``` yaml
82+ # 契约名称
83+ # 模块定位:简述契约用途
84+
85+ # 资产定义
86+ assets :
87+ <asset-name> :
88+ title : 资产标题
89+ type : 资产类型
90+ path : 资产路径
91+ description : 资产描述
8992` ` `
9093
9194## 工作流程
9295
93961. 创建分支:基于 main 创建功能分支
94972. 开发:在分支上进行开发
95983. 提交:使用 Conventional Commits 格式提交
96- 4 . 推送:推送分支并创建 PR
99+ 4. 推送:推送分支并创建 PR
You can’t perform that action at this time.
0 commit comments