Skip to content

Commit adbe99f

Browse files
committed
docs: transform CONTRIBUTING to SKILL maintenance guide
1 parent cf89197 commit adbe99f

1 file changed

Lines changed: 48 additions & 54 deletions

File tree

CONTRIBUTING.md

Lines changed: 48 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,61 @@
11
# CONTRIBUTING
22

3-
项目结构见 [README](./README.md)
3+
本项目是量潮科技工作手册系统,采用多仓架构管理数字资产
44

5-
## 使用场景
5+
## 项目结构
66

7-
### 文档更新
7+
[README](./README.md)
88

9-
修改 `docs/` 下的子模块内容,在子模块内提交并推送,然后更新主仓库引用。
9+
## SKILL 维护指南
1010

11-
1. 子模块内提交:`git -C docs/handbook commit -m "docs: update content"`
12-
2. 子模块内推送:`git -C docs/handbook push`
13-
3. 更新主仓库引用:`git add docs/handbook && git commit -m "chore: update handbook submodule"`
11+
本项目的 AI Agent 技能存储在 `.agents/skills/` 目录。
1412

15-
### 代码开发
13+
### SKILL 目录结构
1614

17-
修改 `src/` 下的子模块,遵循子模块内的 AGENTS.md 规范。
15+
```
16+
.agents/skills/
17+
├── <skill-name>/
18+
│ └── SKILL.md
19+
```
20+
21+
### 创建新 SKILL
22+
23+
1.`.agents/skills/` 下创建技能目录
24+
2. 编写 `SKILL.md`,包含:
25+
- YAML 头:`name``description`
26+
- 技能说明和使用方法
27+
28+
### SKILL 格式规范
29+
30+
```yaml
31+
---
32+
name: <skill-name>
33+
description: 技能描述,说明使用场景
34+
---
35+
```
36+
37+
### 同步 SKILL 到子仓库
38+
39+
稳定的 SKILL 可同步到 gallery 仓库:
40+
41+
```bash
42+
# 复制到 gallery
43+
cp .agents/skills/<skill>/SKILL.md docs/gallery/devops/<skill>/SKILL.md
44+
45+
# 在 gallery 子模块提交
46+
cd docs/gallery
47+
git add devops/<skill>/SKILL.md
48+
git commit -m "docs: add <skill> skill"
49+
git push
1850

19-
## 工作原则
51+
# 更新主仓库引用
52+
cd ..
53+
git add docs/gallery
54+
git commit -m "chore: update gallery submodule"
55+
git push
56+
```
2057

21-
1. 最小干预:仅在用户明确请求时操作
22-
2. 原子提交:每次提交独立完整
23-
3. 验证优先:修改后检查文件命名和内容
24-
4. 明确命名:严格按照规范命名文件
25-
5. 反思学习:从错误中学习并改进工作流程
26-
6. 写作规范:遵循本文档中的文档写作标准
58+
---
2759

2860
## 子模块操作
2961

@@ -62,41 +94,3 @@ git push
6294
2. 开发:在分支上进行开发
6395
3. 提交:使用 Conventional Commits 格式提交
6496
4. 推送:推送分支并创建 PR
65-
66-
---
67-
68-
## 文档写作标准
69-
70-
遵循 [Google 文档风格指南](https://google.github.io/styleguide/docguide/style.html)[量潮科技写作格式标准](../specification/write/format.md)
71-
72-
### 写作原则
73-
74-
- 删:删除不必要的格式元素,优先用段落和标题
75-
- 简:能用列表就不表格,能用文字就不列表
76-
- 少:全文格式元素(分隔线、表格、加粗)尽量少
77-
- 一:同一概念全程使用相同名称
78-
79-
### 核心原则
80-
81-
- 简洁:删除冗余词汇,用词简洁
82-
- 一致:全文术语统一,格式一致
83-
- 主动:使用主动语态,直接表达
84-
- 具体:提供具体示例,避免模糊表述
85-
86-
### 具体规范
87-
88-
1. 语言简洁:删除不必要的修饰词,避免"非常"、"简单的"、"也就是"
89-
2. 主动语态:优先使用主动句,如"Agent 创建文件"而非"文件被 Agent 创建"
90-
3. 术语统一:同一概念全程使用相同术语
91-
4. 标题层级:最多使用三级标题
92-
5. 列表一致性:无序列表用 `-`,有序列表用 `1.`
93-
6. 代码块标注:必须标注语言类型
94-
95-
```bash
96-
git status
97-
```
98-
99-
```python
100-
def hello():
101-
print("Hello")
102-
```

0 commit comments

Comments
 (0)