# 开发规范

**Repository Path**: wujl1124/development-specifications

## Basic Information

- **Project Name**: 开发规范
- **Description**: 开发规范：专注于制定和推广软件开发最佳实践，涵盖编码标准、测试策略、项目管理和工具使用，助力建设高效能开发团队。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-19
- **Last Updated**: 2026-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚀 开发规范与最佳实践指南

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-2.1.7-green.svg)](https://github.com/your-username/dev-standards)
[![Last Updated](https://img.shields.io/badge/last%20updated-2025--01--20-orange.svg)](https://github.com/your-username/dev-standards)

> 📚 **专注于制定和推广软件开发最佳实践，涵盖编码标准、测试策略、项目管理和工具使用，助力建设高效能开发团队**

## 📖 项目介绍

本项目是一套完整的软件开发规范体系，旨在为开发团队提供统一的编码标准、协作规范和最佳实践指南。通过标准化的开发流程和工具链，帮助团队提升代码质量、开发效率和项目可维护性。

### ✨ 核心特性

- 🎯 **全栈覆盖**：涵盖前端Vue、后端Node.js、通用编程规范
- 🤖 **AI Agent支持**：专为AI Agent开发定制的编程规范和沟通风格
- 🔧 **工具集成**：ESLint、Prettier、TypeScript、Git Hooks等完整工具链
- 📋 **流程规范**：从需求分析到部署上线的完整开发流程
- 🤝 **团队协作**：分支管理、代码审查、提交规范等协作标准
- 💬 **智能交互**：针对AI Agent的沟通风格和响应标准
- 🚀 **持续改进**：基于实际项目经验不断优化的规范体系

## 🏗️ 软件架构

```
开发规范/
├── 📁 通用项目编程规范与指南.md     # 通用编程规范
├── 📁 Agent通用编程规范与指南.md    # AI Agent编程规范
├── 📁 前端VUE/                    # 前端开发规范
│   ├── VUE3项目编程规范与指南(Agent).md
│   ├── 动静态导入开发规范(Agent).md
│   ├── 团队协作规范.md
│   ├── 中大型项目/
│   │   └── 模块化架构命名规范(TS).md
│   ├── 中小型项目/
│   │   ├── 模块化架构命名规范 (JS版).md
│   │   └── 模块化架构命名规范(TS).md
│   └── 小型项目/
│       └── 小型前端项目架构命名规范 (通用).md
├── 📁 后端/                       # 后端开发规范
│   ├── 团队协作规范.md
│   ├── 中大型/
│   │   └── 模块化架构命名与设计规范(TS).md
│   └── 中小型/
│       ├── JS/
│       │   ├── 开发规范文档.md
│       │   └── 通用架构命名与设计规范(JS).md
│       └── TS/
│           └── 通用架构命名与设计规范(TS).md
└── 📄 LICENSE                     # 开源协议
```

### 🎯 规范体系架构

```mermaid
graph TD
    A[开发规范体系] --> B[通用编程规范]
    A --> C[前端Vue规范]
    A --> D[后端Node.js规范]
    A --> E[团队协作规范]
    
    B --> B1[代码规范]
    B --> B2[设计原则]
    B --> B3[质量保证]
    
    C --> C1[Vue3最佳实践]
    C --> C2[组件设计规范]
    C --> C3[状态管理规范]
    
    D --> D1[API设计规范]
    D --> D2[数据库设计规范]
    D --> D3[性能优化规范]
    
    E --> E1[Git工作流]
    E --> E2[代码审查]
    E --> E3[CI/CD流程]
```

## 🚀 快速开始

### 📋 前置要求

- Node.js >= 16.0.0
- Git >= 2.30.0
- VS Code (推荐) 或其他支持ESLint/Prettier的编辑器

### 🔧 安装配置

1. **克隆项目**
   ```bash
   git clone https://gitee.com/your-username/dev-standards.git
   cd dev-standards
   ```

2. **安装依赖** (如果项目包含配置文件)
   ```bash
   npm install
   ```

3. **配置编辑器**
   - 安装ESLint、Prettier扩展
   - 配置自动格式化
   - 启用保存时格式化

### 📖 使用指南

#### 1. 选择适合的规范文档

##### 🎯 项目规模选择指南

**小型项目** (< 10个页面/模块)
- 前端：`前端VUE/小型项目/小型前端项目架构命名规范 (通用).md`
- 后端：`后端/中小型/JS/开发规范文档.md`

**中小型项目** (10-50个页面/模块)
- 前端JS：`前端VUE/中小型项目/模块化架构命名规范 (JS版).md`
- 前端TS：`前端VUE/中小型项目/模块化架构命名规范(TS).md`
- 后端JS：`后端/中小型/JS/通用架构命名与设计规范(JS).md`
- 后端TS：`后端/中小型/TS/通用架构命名与设计规范(TS).md`

**中大型项目** (> 50个页面/模块)
- 前端：`前端VUE/中大型项目/模块化架构命名规范(TS).md`
- 后端：`后端/中大型/模块化架构命名与设计规范(TS).md`

##### 🛠️ 技术栈选择指南

**通用规范**：
- **所有项目** → `通用项目编程规范与指南.md`
- **AI Agent开发** → `Agent通用编程规范与指南.md`

**Vue3项目**：
- **Vue3通用** → `前端VUE/VUE3项目编程规范与指南(Agent).md`
- **动静态导入** → `前端VUE/动静态导入开发规范(Agent).md`

**团队协作**：
- **前端协作** → `前端VUE/团队协作规范.md`
- **后端协作** → `后端/团队协作规范.md`

#### 2. 配置开发环境

**ESLint配置示例**：
```javascript
// .eslintrc.js
module.exports = {
  extends: [
    'eslint:recommended',
    '@typescript-eslint/recommended',
    'prettier'
  ],
  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
  }
}
```

**Prettier配置示例**：
```json
{
  "semi": true,
  "trailingComma": "es5",
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2,
  "useTabs": false
}
```

#### 3. 应用团队协作规范

- 配置Git Hooks
- 设置分支保护规则
- 建立代码审查流程
- 配置CI/CD流水线

### 🤖 Agent开发特色

#### Agent编程规范亮点

**开发环境配置**：
- 🗣️ **中文优先**：项目文档、代码注释及团队沟通均使用中文
- 💻 **Windows环境**：主要开发和运行环境为Windows系统
- ⚡ **PowerShell终端**：推荐使用PowerShell作为命令行终端

**智能交互标准**：
- 💬 **友好表达**：对话中适当使用emoji，增加友好度
- 🔍 **清晰对比**：优先提供"错误示例+正确示例"对比
- 📚 **循序渐进**：复杂问题分步骤解释，避免信息过载
- 👍 **积极反馈**：对用户的正确理解给予肯定

**响应标准格式**：
```javascript
/**
 * 问题分析：清晰描述问题所在
 * 解决方案：提供具体的改进方案
 * 最佳实践：推荐相关的最佳实践
 * 注意事项：提醒需要注意的细节
 */
```

## 📚 规范文档详解

### 🎯 核心规范

#### 📚 通用规范
| 规范类型 | 文档路径 | 适用场景 | 核心内容 |
|---------|---------|---------|---------|
| **通用编程规范** | `通用项目编程规范与指南.md` | 所有项目 | 代码规范、设计原则、质量保证 |
| **Agent编程规范** | `Agent通用编程规范与指南.md` | AI Agent开发 | 开发环境配置、沟通风格、智能交互标准 |

#### 🎨 前端规范
| 项目规模 | 技术栈 | 文档路径 | 核心内容 |
|---------|--------|---------|---------|
| **Vue3通用** | Vue3 | `前端VUE/VUE3项目编程规范与指南(Agent).md` | 组件设计、状态管理、性能优化 |
| **中大型项目** | TypeScript | `前端VUE/中大型项目/模块化架构命名规范(TS).md` | 模块化架构、命名规范、设计模式 |
| **中小型项目** | JavaScript | `前端VUE/中小型项目/模块化架构命名规范 (JS版).md` | 轻量级架构、命名规范 |
| **中小型项目** | TypeScript | `前端VUE/中小型项目/模块化架构命名规范(TS).md` | 类型安全、模块化设计 |
| **小型项目** | JS/TS通用 | `前端VUE/小型项目/小型前端项目架构命名规范 (通用).md` | 简单架构、快速开发 |

#### 🚀 后端规范
| 项目规模 | 技术栈 | 文档路径 | 核心内容 |
|---------|--------|---------|---------|
| **团队协作** | 通用 | `后端/团队协作规范.md` | Git工作流、代码审查、CI/CD |
| **中大型项目** | TypeScript | `后端/中大型/模块化架构命名与设计规范(TS).md` | 企业级架构、微服务设计 |
| **中小型项目** | JavaScript | `后端/中小型/JS/开发规范文档.md` | 全栈开发规范、Node.js最佳实践 |
| **中小型项目** | JavaScript | `后端/中小型/JS/通用架构命名与设计规范(JS).md` | 轻量级架构、命名规范 |
| **中小型项目** | TypeScript | `后端/中小型/TS/通用架构命名与设计规范(TS).md` | 类型安全、模块化设计 |

### 🔧 工具链配置

#### 代码质量工具
- **ESLint**: 代码静态分析
- **Prettier**: 代码格式化
- **TypeScript**: 类型检查
- **Husky**: Git Hooks管理
- **lint-staged**: 提交前检查

#### 开发流程工具
- **Git Flow**: 分支管理策略
- **Conventional Commits**: 提交信息规范
- **GitHub Actions**: CI/CD自动化
- **Code Review**: 代码审查流程

## 🤝 参与贡献

我们欢迎所有形式的贡献！无论是文档改进、规范优化还是新功能建议。

### 📝 贡献流程

1. **Fork 本仓库** 🍴
2. **创建功能分支** `git checkout -b feature/amazing-feature`
3. **提交你的更改** `git commit -m 'feat: add amazing feature'`
4. **推送分支** `git push origin feature/amazing-feature`
5. **创建 Pull Request** 📋

### 🎯 贡献类型

- 📖 **文档改进**：完善规范文档、添加示例
- 🔧 **工具优化**：改进工具链配置、添加新工具
- 🐛 **问题修复**：修复规范中的错误或不一致
- ✨ **新功能**：添加新的规范或最佳实践
- 🌍 **国际化**：翻译文档到其他语言

### 📋 提交规范

我们使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范：

```
<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]
```

**提交类型**：
- `feat`: 新功能
- `fix`: 问题修复
- `docs`: 文档更新
- `style`: 代码格式调整
- `refactor`: 代码重构
- `test`: 测试相关
- `chore`: 构建工具或依赖更新

## 📄 开源协议

本项目基于 [MIT License](LICENSE) 开源协议。

## 🌟 特别感谢

感谢所有为这个项目做出贡献的开发者们！你们的贡献让开发规范体系更加完善。

## 📞 联系我们

- 📧 **邮箱**: your-email@example.com
- 💬 **讨论**: [GitHub Discussions](https://github.com/your-username/dev-standards/discussions)
- 🐛 **问题反馈**: [GitHub Issues](https://github.com/your-username/dev-standards/issues)

---

<div align="center">

**⭐ 如果这个项目对你有帮助，请给我们一个 Star！**

[![Star History Chart](https://api.star-history.com/svg?repos=your-username/dev-standards&type=Date)](https://star-history.com/#your-username/dev-standards&Date)

</div>