Skills 目录说明

skills/ 目录提供了 WebServer 模板项目的完整开发规范、编码标准和技能指南，帮助开发者快速上手并遵循统一的开发规范。

skills/
├── README.md                 # 本文件：Skills 目录说明
├── SKILL.md                  # 📌 主入口：项目规范与开发指南
├── coding-standards.md       # 📐 编码规范（详细）
├── fullstack/SKILL.md        # 🔧 全栈开发技能
├── database/SKILL.md         # 💾 数据库层开发技能
├── frontend/SKILL.md         # 🎨 前端开发技能
└── backend/SKILL.md          # ⚙️ 后端开发技能

# 创建项目
npm init jtemplate my-project-name

# 进入项目目录
cd my-project-name

# 一键安装所有依赖（自动检测 pnpm/npm）
npm run init

查看 SKILL.md 了解：

• 项目初始化步骤
• 编码规范快速导航
• 开发技能速览
• 常见任务指南

查看 coding-standards.md 了解：

• 编辑器配置（EditorConfig、ESLint、Prettier）
• 后端编码规范（Controller、Service、Entity、DTO）
• 前端编码规范（Vue 组件、TypeScript）
• 命名规范、Git 提交规范

根据开发任务选择对应的技能文档：

• 开发完整功能 → fullstack/SKILL.md
• 数据库相关 → database/SKILL.md
• 前端页面 → frontend/SKILL.md
• 后端接口 → backend/SKILL.md

• ✅ 一键创建项目指南
• ✅ 编码规范快速导航
• ✅ 开发技能速览表格
• ✅ 常见任务指南（5 个典型任务）
• ✅ 完整项目结构展示
• ✅ 常见问题 FAQ

• 🛠️ 编辑器配置（EditorConfig、ESLint、Prettier）
• 🔧 后端编码规范（Controller、Service、Entity、DTO）
• 🎨 前端编码规范（Vue 组件、TypeScript）
• 📝 命名规范（文件、类、变量、常量）
• 📦 Git 提交规范（Conventional Commits）
• 🔍 代码检查工具
• ✨ 最佳实践

每个技能文档包含：

• 🎯 技能概述
• 📋 开发步骤
• 💻 代码示例
• ⚠️ 注意事项
• 🔗 相关规范链接

# 代码检查
npm run lint

# 自动修复
npm run lint:fix

# 类型检查
npm run type-check

# 运行测试
npm run test

1. 新成员入门

   • SKILL.md → 了解项目整体架构
   • coding-standards.md → 学习编码规范
   • fullstack/SKILL.md → 掌握完整开发流程

2. 日常开发

   • coding-standards.md → 查阅具体规范
   • 对应的技能文档 → 参考代码示例和步骤

3. 问题排查

   • SKILL.md → 查看 FAQ
   • coding-standards.md → 查看最佳实践

• ✅ 代码风格（EditorConfig、ESLint、Prettier）
• ✅ 后端开发（Controller、Service、Entity、DTO）
• ✅ 前端开发（Vue 3、TypeScript）
• ✅ 命名规范（文件、类、变量、常量）
• ✅ Git 提交规范（Conventional Commits）
• ✅ 代码检查工具
• ✅ 最佳实践

1. 开发前：先阅读编码规范中的相关章节
2. 开发中：参考技能文档中的代码示例
3. 开发后：运行 npm run lint:fix 自动修复
4. 提交前：按照 Git 规范编写提交信息

• 项目主文档
• 更新日志
• 问题反馈

版本: 2.0.0
更新日期: 2026-02-02