# modstart-agents

**Repository Path**: modstart-lib/modstart-agents

## Basic Information

- **Project Name**: modstart-agents
- **Description**: 使用AI快速开发ModStart项目
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-14
- **Last Updated**: 2026-01-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🤖 ModStart AI 编程规范

欢迎使用 ModStart AI 编程规范！🌟

本项目旨在为 ModStart 生态的开发者提供一套一致的编码风格、最佳实践以及系统开发指南。它经过特别优化，能够帮助 AI 编程助手（如 Copilot、Cursor）更准确地理解你的项目上下文，从而显著提升代码质量与开发效率。

本项目使用 [OpenSpec](https://openspec.dev/) AI开发规范。

---

## 🚀 快速开始

只需几步，即可为你的项目注入 AI 编程规范。

### 1. 环境准备

在开始之前，请确保你的开发环境满足以下要求：

- **Node.js**: 请前往 [Node.js 官网](https://nodejs.org/) 下载并安装最新的 LTS 版本。
- **OpenSpec**: 安装 OpenSpec 命令行工具（需要 Node.js >= 20 环境）。

```shell
npm install -g openspec
```

### 2. 初始化配置

将本规范应用到你的 ModStart 项目中：

1.  **复制文件**: 将本仓库中的所有文件复制到你的 ModStart 项目根目录下。
2.  **初始化**: 在项目根目录运行以下命令，`openspec` 会自动识别并加载这些规范文件。

```shell
openspec init
```

### 3. 检查配置

初始化完成后，建议检查以下关键配置文件，确保符合你的实际项目需求：

- `/openspec/project.md`: 修改为 `AGENTS.md` 的全部内容。

---

## 🛠️ AI 开发工作流

按照以下步骤，体验高效的 AI 辅助开发流程：

### 第一步：创建需求文档 📝

在对话框中使用 `/openspec-proposal` 命令描述你的需求。AI 将自动为你生成一份详细的需求文档。

```shell
/openspec-proposal 这里输入你的需求描述...
```

*文档生成后，查看相关需求和功能描述，确保其准确无误。*

更多使用示例，请参考 [OpenSpec 官方文档](https://openspec.dev)。

### 第二步：生成代码 ⚡

确认需求文档无误后，使用 `/openspec-apply` 命令让 AI 开始编写代码。

```shell
/openspec-apply
```

---

## 🤖 支持的 AI 编辑器

本项目规范经过精心打磨，与以下先进的 AI 辅助开发工具配合效果最佳：

- [GitHub Copilot](https://github.com/features/copilot)
- [Cursor](https://cursor.sh/)
- [Trae](https://www.trae.ai/)

---

## 📄 开源协议

本项目遵循 [Apache License 2.0](LICENSE) 开源协议。