docs:新增 AI 辅助开发规范指南并更新文档
新增功能: - 创建完整的 AI 辅助开发工作流程指南 - 提供实用的提示词模板和检查清单 - 包含详细的实战案例和最佳实践 文档更新: - 在 README 中强调 AI 指南的重要性 - 添加醒目的必读警告和使用建议 - 重新组织开发文档结构 本次更新旨在帮助开发者使用 AI 工具遵循项目规范, 显著提高开发效率和代码质量。
This commit is contained in:
55
README.md
55
README.md
@@ -2,6 +2,22 @@
|
||||
|
||||
一个基于 NestJS 的 2D 像素风游戏后端服务
|
||||
|
||||
---
|
||||
|
||||
## 🚨 开发者必读警告
|
||||
|
||||
**⚠️ 在开始任何开发工作之前,请务必阅读:[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)**
|
||||
|
||||
**📢 重要提醒:**
|
||||
- 🚫 **未阅读 AI 辅助指南的代码将无法通过审查**
|
||||
- 🤖 **学会使用 AI 助手可以让你的开发效率提升 300%**
|
||||
- 📝 **AI 可以帮你自动生成符合规范的代码和注释**
|
||||
- 🔍 **AI 可以实时检查你的代码质量**
|
||||
|
||||
**👉 [立即阅读 AI 辅助开发指南](./docs/AI辅助开发规范指南.md)**
|
||||
|
||||
---
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **NestJS** `^10.4.20` - 渐进式 Node.js 框架
|
||||
@@ -37,6 +53,22 @@
|
||||
- `typescript` `^5.9.3` - TypeScript 编译器
|
||||
- `pino-pretty` `^13.1.3` - Pino 美化输出
|
||||
|
||||
## 🚨 重要:开发前必读
|
||||
|
||||
### ⚠️ 所有开发者必须先阅读 AI 辅助开发指南
|
||||
|
||||
**在开始任何开发工作之前,请务必阅读:[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)**
|
||||
|
||||
这个指南将教你如何:
|
||||
- 🤖 使用 AI 助手遵循项目规范
|
||||
- 📝 自动生成规范的代码和注释
|
||||
- 🔍 实时检查代码质量
|
||||
- 🚀 显著提高开发效率和代码质量
|
||||
|
||||
**不阅读此指南直接开发,代码审查将无法通过!**
|
||||
|
||||
---
|
||||
|
||||
## 开发规范
|
||||
|
||||
### 命名规范
|
||||
@@ -130,17 +162,26 @@ export class PlayerService {
|
||||
|
||||
详细规范请查看:[后端开发规范指南](./docs/backend_development_guide.md)
|
||||
|
||||
## 文档
|
||||
## 📚 开发文档
|
||||
|
||||
- [NestJS 使用指南](./docs/nestjs_guide.md) - 详细的 NestJS 开发指南,包含实战案例
|
||||
- [命名规范](./docs/naming_convention.md) - 项目命名规范和最佳实践
|
||||
- [Git 提交规范](./docs/git_commit_guide.md) - Git 提交信息格式和最佳实践
|
||||
### 🔥 必读文档
|
||||
- **[AI 辅助开发规范指南](./docs/AI辅助开发规范指南.md)** - 🚨 **所有开发者必读!** 教你如何使用 AI 遵循项目规范
|
||||
|
||||
### 📋 规范文档
|
||||
- [后端开发规范](./docs/backend_development_guide.md) - 注释标准、业务逻辑设计和日志记录要求
|
||||
- [Git 提交规范](./docs/git_commit_guide.md) - Git 提交信息格式和最佳实践
|
||||
- [命名规范](./docs/naming_convention.md) - 项目命名规范和最佳实践
|
||||
- [NestJS 使用指南](./docs/nestjs_guide.md) - 详细的 NestJS 开发指南,包含实战案例
|
||||
|
||||
### 💡 使用建议
|
||||
1. **开发前**:先读 AI 辅助指南,了解如何用 AI 帮助遵循规范
|
||||
2. **开发中**:参考具体规范文档,使用 AI 实时检查代码质量
|
||||
3. **提交前**:用 AI 检查代码和提交信息是否符合规范
|
||||
|
||||
## 前置要求
|
||||
|
||||
- **Node.js** >= 18.0.0
|
||||
- **pnpm** >= 8.0.0(推荐)
|
||||
- **Node.js** >= 18.0.0 默认:24.7.0
|
||||
- **pnpm** >= 8.0.0(推荐)默认:10.25.0
|
||||
|
||||
如果还没有安装 pnpm,请先安装:
|
||||
|
||||
@@ -281,6 +322,8 @@ export class UserService {
|
||||
|
||||
详细使用方法请参考:[后端开发规范指南 - 日志系统使用指南](./docs/backend_development_guide.md#四日志系统使用指南)
|
||||
|
||||
**💡 提示:使用 [AI 辅助开发指南](./docs/AI辅助开发规范指南.md) 可以让 AI 帮你自动生成符合规范的日志代码!**
|
||||
|
||||
## 下一步
|
||||
|
||||
- 在 `src/api/` 目录下创建游戏相关的控制器和网关
|
||||
|
||||
Reference in New Issue
Block a user