redev-dev-standards
Version:
Development standards management tool for multi-project teams with intelligent config merging
129 lines (90 loc) • 3.7 kB
Markdown
# Redev Development Standards
🚀 **多项目开发标准管理工具** - 为多项目团队提供智能配置合并的开发标准管理解决方案
## 📋 项目概述
这个工具帮助团队在多个项目中统一开发标准,同时保留每个项目的个性化配置。通过智能配置合并机制,确保公司级标准的一致性,同时允许项目级别的自定义。
## ✨ 核心特性
- 🎯 **智能配置合并** - 自动合并公司级标准与项目特定设置
- 🔄 **版本管理** - 自动检查并提示包更新
- 🛡️ **配置保护** - 保护项目特定设置不被覆盖
- 🌐 **中文界面** - 完整的中文提示和交互
- 🤖 **AI 集成** - 与 Cursor AI 无缝集成,自动分析技术栈
- 📁 **模板系统** - 基于模板的配置生成和更新
- 🔗 **JIRA 集成** - 自动获取任务详情,解析 Wiki 链接
- 📚 **Wiki 集成** - 自动读取相关技术文档和规范
## 🚀 快速开始
### 初始化项目
在项目根目录运行:
```bash
npx redev-dev-standards init
```
这将引导您完成项目初始化,包括:
- 项目基本信息
- 合并请求目标分支策略
- 生成完整的项目规范结构
### 更新项目规范
当公司级规范有更新时,运行:
```bash
npx redev-dev-standards update
```
这将:
- ✅ 检查是否有新版本的包可用
- ✅ 智能合并最新的公司级规范
- ✅ 保留项目的个性化设置
- ✅ 更新所有相关文件
## 🤖 在 Cursor 中使用
初始化项目后,你可以直接向 Cursor AI 表达开发意图,AI 会自动根据项目配置文件执行相应的操作。
### 支持的意图表达
#### 1. 开发新功能
**用户表达**: `我要开始开发新功能 AZRD-12345`
**AI 响应**:
- 自动获取 JIRA 任务详情和 Wiki 文档
- 根据工作流程创建分支
- 提供任务上下文和开发建议
#### 2. 代码审查
**用户表达**: `帮我审查这段代码`
**AI 响应**: 根据代码审查规范进行检查,提供改进建议
#### 3. 提测准备
**用户表达**: `准备提测 AZRD-12345`
**AI 响应**:
- 执行提测流程,提供检查清单
- 获取 JIRA 任务详情和 Wiki 文档
- 提供 JIRA 状态更新建议(手动操作)
#### 4. 发布部署
**用户表达**: `发布到测试1环境`
**AI 响应**:
- 执行部署流程,调用 Jenkins 部署
- 获取 JIRA 任务详情和 Wiki 文档
- 提供 JIRA 状态更新建议(手动操作)
#### 5. 问题排查
**用户表达**: `这个功能有问题,帮我排查`
**AI 响应**: 分析问题,提供解决方案
### 意图表达技巧
- **使用标准术语**: JIRA 编号 (AZRD-12345)、环境名称 (测试1, pre2)
- **明确操作类型**: 开发、审查、测试、部署
- **具体化需求**: 明确功能模块、问题类型
### 故障排除
如果 AI 没有理解意图,可以明确引用配置文件:
```
请按照 specs/workflows/development.yaml 中的流程来创建分支
请参考 specs/standards/code-review.yaml 来审查这段代码
```
## 💡 使用示例
```bash
# 1. 初始化项目
npx redev-dev-standards init
# 2. 使用 Cursor AI 分析技术栈
# 在 Cursor 中输入:请分析这个项目并填写技术栈信息
# 3. 开始开发
# 用户: "我要开始开发新功能 AZRD-12345"
# AI: 自动获取 JIRA 详情,创建分支并遵循工作流程
# 4. 定期更新标准
npx redev-dev-standards update
```
## 📖 详细文档
查看 [USAGE.md](./USAGE.md) 获取完整使用指南,包括安装方式、AI 集成、故障排除等。
## 📄 许可证
ISC License
## 👥 贡献
欢迎提交 Issue 和 Pull Request!
---
**Made with ❤️ by Redev Team**