Skip to content

About

AI Coding 实践工具箱 - 经验沉淀、规则规范、模板集合

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

coding-agents

AI Coding 实践工具箱 - 经验沉淀、规则规范、模板集合

个人 AI 辅助开发经验总结,提炼可复用的 Skills、编码规范和开发模板。支持 Trae、Claude Code、Cursor 等主流 AI Coding IDE。

适用人群

  • 想要建立个人开发规范的开发者
  • 团队需要统一 AI 编码规范的 Leader
  • 希望复用量身定制 Skills 的使用者

目录结构

coding-agents/
├── skills/                      # AI Agent Skills(经验沉淀)
│   ├── go-testing/              │   Go 测试最佳实践
│   ├── golang-patterns/         │   Go 设计模式与高阶实践
│   ├── dev-workflow/            │   开发流程五步法
│   ├── feature-development/     │   功能开发全流程
│   ├── git-commit/              │   Git Commit 生成
│   └── session-summary/         │   会话摘要沉淀
├── rules/                       # 编码规范(规则定义)
│   ├── go-conventions.md        │   Go 编码规范
│   ├── coding-standards.md      │   通用代码质量规范
│   └── ai-coding-workflow.md    │   AI Coding 工作流规范
├── templates/                   # 开发模板(文档骨架)
│   ├── spec.md                  │   技术规格说明
│   ├── tasks.md                 │   任务拆解清单
│   └── checklist.md             │   验收检查清单
├── external/                    # 外部 Skills 引用(仅记录地址)
│   └── README.md                │   外部 Skill Git 地址清单
├── scripts/                     # 辅助脚本
│   ├── setup-symlink.sh         │   项目符号链接
│   ├── create-spec.sh           │   创建需求模板
│   └── check-links.sh           │   验证外部链接
└── docs/                        # IDE 配置模板
    ├── AGENTS.md                │   Agent 入口指南
    └── CLAUDE.md                │   项目规则入口

Skills 详解

即开即用的 AI Agent Skills,在各 IDE 的 Skills 目录直接使用:

Skill 描述 何时使用
go-testing Go 测试最佳实践(table-driven、subtests、go-cmp) 编写/审查 Go 测试代码
golang-patterns Go 设计模式与高阶实践 设计包/模块/接口时
dev-workflow 开发流程五步法(需求→设计→实现→Bug修复→审查) 需求分析、方案设计
feature-development 功能开发全流程 从 0 到 1 完成功能开发
git-commit Conventional Commits 规范 生成规范的提交信息
session-summary 会话摘要沉淀 知识复用、团队共享

每个 Skill 包含 SKILL.md 入口文件和详细参考文档。

Rules 详解

编码规范与工作流规则,适用于所有项目的通用规范:

文件 描述
go-conventions.md Go 编码规范(命名、错误处理、并发、测试)
coding-standards.md 通用代码质量规范(交互、代码改动、重构)
ai-coding-workflow.md AI Coding 工作流规范(Plan-Build-Verify)

Templates 详解

需求开发文档模板,直接复制到项目中使用:

模板 用途
spec.md 技术规格说明 - 背景、需求、技术方案、接口、数据模型
tasks.md 任务拆解清单 - 开发任务跟踪与进度管理
checklist.md 验收检查清单 - 功能上线前的验收标准

使用方式

方式一:直接复制(推荐)

# 1. 克隆仓库
git clone https://your-gitlab/coding-agents.git
cd coding-agents

# 2. 复制 Skills(根据你的 IDE 调整)
cp -r skills/* ~/.trae/skills/       # Trae
cp -r skills/* ~/.claude/skills/     # Claude Code
cp -r skills/* ~/.cursor/skills/     # Cursor

# 3. 复制 Rules
cp -r rules/* ~/.trae/rules/         # Trae

# 4. 复制模板到项目
mkdir -p your-project/.trae/specs/my-feature
cp templates/*.md your-project/.trae/specs/my-feature/

方式二:符号链接(修改自动同步)

# 在目标项目中创建目录
mkdir -p ~/.trae/skills ~/.trae/rules

# 符号链接
ln -s /path/to/coding-agents/skills/* ~/.trae/skills/
ln -s /path/to/coding-agents/rules/* ~/.trae/rules/

方式三:辅助脚本

# 链接到目标项目(默认 .trae/)
./scripts/setup-symlink.sh /path/to/your/project

# 链接到其他 IDE
./scripts/setup-symlink.sh /path/to/your/project claude
./scripts/setup-symlink.sh /path/to/your/project cursor

# 创建需求模板
./scripts/create-spec.sh user-auth                     # 默认 .trae/specs/
./scripts/create-spec.sh user-auth .claude/specs      # 指定目录

# 检查外部 Skill 链接有效性
./scripts/check-links.sh

IDE 兼容说明

IDE 配置目录 Skills 目录 Rules 目录
Trae .trae/ .trae/skills/ .trae/rules/
Claude Code .claude/ .claude/skills/ .claude/rules/
Cursor .cursor/ .cursor/skills/ .cursor/rules/

核心内容(skills、rules、templates)与 IDE 无关,用户自行复制到对应目录即可。


外部 Skills

外部优秀 Skills 的 Git 地址清单,不复制代码,仅记录地址,使用时自行 clone。

详见 external/README.md

使用示例:

# 克隆 code-review-skill
git clone https://github.com/awesome-skills/code-review-skill.git \
  ~/.trae/skills/code-review-skill

# 使用:在对话中说 "Use code-review-skill to review this PR"

自定义扩展

  1. 添加自己的 Skills:在 skills/ 下创建新目录,编写 SKILL.md
  2. 新增编码规范:在 rules/ 下添加 .md 文件
  3. 完善模板:修改 templates/ 下的模板文件

许可证

MIT License - 可自由使用、修改和分发。

About

AI Coding 实践工具箱 - 经验沉淀、规则规范、模板集合

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages