@gdin/skills
v0.0.1
Published
GDIN 团队 AI 开发 skills 集合
Maintainers
Readme
@gdin/skills
GDIN 团队 AI 开发 Skills 集合
为 Claude Code 和 Codex 提供的团队规范自动化工具,帮助 AI 助手遵循 GDIN 团队的开发规范和最佳实践。
✨ 核心特性
- 🎯 前端开发规范自动化 - 通过
frontend-rulesskill 自动加载和应用团队前端编码规范 - 📋 智能规则检索 - AI 根据任务类型自动加载相关规范章节,避免信息过载
- 🔄 多平台支持 - 同时支持 Claude Code 和 Codex
- 🌐 本地化优先 - 中文交互,符合国内团队习惯
- 🛡️ 仓库级配置优先 - 尊重项目本地的 AGENTS.md 配置
- ⚡ 计划驱动开发 - 要求在实现前提供方案和计划,减少返工
🚀 快速开始
前置要求
- Claude Code >= 1.0.0 或 Codex >= 1.0.0
- Git 访问权限到 GDIN 仓库
- SSH 密钥配置
安装
使用 npx skills add 命令从 Git 仓库安装:
npx skills add http://172.169.112.6/frame/web/gdin-skills安装完成后,重启 Claude Code 或 Codex 使插件生效。
更新插件
npx skills update @gdin/skills或者更新所有已安装的 skills:
npx skills update验证安装
安装完成后,插件会自动加载。可以通过以下方式验证:
- 在对话中提到前端相关任务时,
frontend-rulesskill 会自动触发 - 使用
/plugins list命令查看已安装的插件列表
更新插件
/plugins update @gdin/skills --registry http://172.169.77.25:4873/📚 Skills 详细说明
frontend-rules
前端开发规范 skill,在前端编码前自动检索并按规范执行。
触发条件
当 AI 助手准备执行以下操作时自动触发:
- 分析、设计、实现、修改、重构或审查前端代码
- 涉及技术栈:React、Vue、TypeScript、Umi、Ant Design、@gdin 包、Less/CSS
- 处理内容:请求服务、页面、组件、hooks、状态管理、前端构建逻辑
工作流程
- 识别任务类型 - 判断是 explain(解释)、plan(规划)、implement(实现)还是 review(审查)
- 加载规则索引 - 读取
references/rules-index.md获取规则目录 - 读取相关规则 - 从
references/AI-RULES.md中只加载相关章节 - 应用本地配置 - 优先应用仓库本地的
AGENTS.md配置 - 检查规则更新 - 确认是否有更新的规则版本
- 提供实现计划 - 在编码前提供方案、范围、复用点、风险和验证方法
- 等待用户确认 - 只有在用户确认计划后才开始实现
核心行为
- ✅ 保持中文响应
- ✅ 优先使用项目现有组件、hooks、工具、请求封装和样式
- ❌ 不生成单元测试代码
- ❌ 不执行 git 操作(除非用户明确要求)
- ❌ 不创建额外的文档文件(除非用户明确要求)
- ⚠️ 任务模糊时先询问,不要假设
任务模式
| 模式 | 说明 | 行为 | |------|------|------| | Explain | 解释分析 | 只分析代码,不修改 | | Plan | 规划方案 | 提供 2-3 种方案及权衡,等待确认 | | Implement | 实现功能 | 列出文件,说明方法,只修改请求的范围 | | Review | 代码审查 | 报告问题、风险和合并检查,不修改代码 |
💡 使用示例
示例 1:实现新的 React 组件
用户:帮我实现一个用户列表页面AI 响应流程:
- 触发
frontend-rulesskill - 加载相关规则(React、组件、页面、请求)
- 检查项目现有的列表组件和请求封装
- 提供实现计划:
- 复用现有的
ProTable组件 - 使用项目的
request工具 - 遵循项目的目录结构
- 复用现有的
- 等待用户确认
- 实现代码
示例 2:重构现有页面
用户:重构 src/pages/Dashboard/index.tsx,拆分成更小的组件AI 响应流程:
- 触发
frontend-rulesskill(任务类型:implement + refactor) - 读取现有代码
- 提供重构方案:
- 方案 A:按功能拆分(推荐)
- 方案 B:按布局拆分
- 等待用户选择
- 执行重构
示例 3:代码审查
用户:审查 src/components/UserForm/index.tsxAI 响应流程:
- 触发
frontend-rulesskill(任务类型:review) - 加载审查相关规则
- 检查代码问题:
- 是否遵循命名规范
- 是否正确使用 hooks
- 是否有性能问题
- 是否符合项目约定
- 提供审查报告,不修改代码
⚙️ 配置说明
仓库级配置
在项目根目录创建 AGENTS.md 文件可以覆盖默认规则:
# 项目特定规则
## 组件命名
- 使用 PascalCase
- 文件名与组件名一致
## 状态管理
- 优先使用 Zustand
- 避免使用 Redux配置优先级
- 项目本地
AGENTS.md- 最高优先级 frontend-rules规则文件 - 默认规则- AI 助手内置知识 - 最低优先级
📁 文件结构
@gdin/skills/
├── package.json # 包配置
├── plugin.json # 插件元数据
├── README.md # 项目文档
├── bin/ # CLI 工具
│ └── gdin-skills.js
├── docs/ # 设计文档和规范
│ ├── AI-RULES.md # 前端编程规范(提供给AI的)
│ └── 前端AI编程规范(团队版).md # 前端编程规范(前端团队)
└── skills/ # Skills 目录
└── frontend-rules/ # 前端规范 skill
├── SKILL.md # Skill 定义
└── references/ # 规则文件
├── AI-RULES.md # 完整规则文档
├── rules-index.md # 规则索引
├── claude-adapter.md # Claude 适配器
├── codex-adapter.md # Codex 适配器
└── update-policy.md # 更新策略🔧 故障排查
Skill 未加载
问题: 安装后 skill 没有出现在列表中
解决方案:
- 检查插件是否正确安装:
claude-code plugins list - 重启 Claude Code 或 Codex
- 检查
plugin.json格式是否正确 - 查看日志文件获取错误信息
规则文件找不到
问题: Skill 触发但提示找不到规则文件
解决方案:
- 确认
skills/frontend-rules/references/目录存在 - 检查文件权限
- 重新安装插件
触发条件不生效
问题: 前端任务没有自动触发 skill
解决方案:
- 检查
SKILL.md中的description字段 - 确认任务描述包含触发关键词
- 手动指定使用 skill
与其他插件冲突
问题: 安装后与其他插件产生冲突
解决方案:
- 检查是否有多个插件提供相同的 skill
- 调整插件加载顺序
- 禁用冲突的插件
❓ FAQ
为什么需要这个插件?
传统的 CLAUDE.md 或 AGENTS.md 文件会在每次对话时全量加载,导致:
- 上下文窗口浪费
- 响应速度变慢
- 规则难以维护
@gdin/skills 通过智能检索,只加载相关规则,提高效率。
与直接写 CLAUDE.md 有什么区别?
| 特性 | CLAUDE.md | @gdin/skills | |------|-----------|--------------| | 加载方式 | 全量加载 | 按需加载 | | 维护性 | 单文件,难维护 | 模块化,易维护 | | 复用性 | 项目级 | 团队级 | | 更新 | 手动同步 | 自动检查更新 | | 平台支持 | Claude Code | Claude Code + Codex |
如何更新规则?
规则更新有两种方式:
- 自动更新: Skill 会检查是否有新版本,提示用户更新
- 手动更新:
npx skills update @gdin/skills
是否支持其他 AI 工具?
当前支持:
- ✅ Claude Code
- ✅ Codex
如何贡献新的 Skill?
- Fork 仓库
- 创建新的 skill 分支
- 按照开发指南创建 skill
- 提交 Merge Request
- 等待代码审查
🗺️ 路线图
- ✅ v0.0.1 - frontend-rules skill 基础功能
- 🚧 v0.1.0 - 计划中的功能
- 后端开发规范 skill
- 数据库设计规范 skill
- API 设计规范 skill
- 📋 未来规划
- 支持更多 AI 工具
- 可视化规则编辑器
- 规则版本管理
- 团队协作功能
📄 许可证
本项目采用 MIT 许可证。
