chore: migrate project into clean repository

This commit is contained in:
yuuux
2026-08-13 16:50:52 +08:00
commit d1d25a09e7
27405 changed files with 9422808 additions and 0 deletions

View File

@@ -0,0 +1,41 @@
根据当前的代码修改生成简洁的中文 git 提交信息。
执行以下步骤:
1. 并行运行 `git status``git diff --cached` 查看已暂存的改动
2. 如果有已暂存的改动staged只针对这些改动生成提交信息
3. 如果没有已暂存的改动,查看所有未暂存改动 (`git diff`),并询问是否 add 所有改动
4. 分析修改内容,识别模块和改动类型
5. 生成提交信息,包含标题和详细说明
6. 询问用户是否创建 commit如果确认则使用 `git commit -s` 添加个人签名
## 提交信息格式
```
<type>(<scope>): <简短标题>
<详细说明2-3行说明
- 具体改动内容
- 改动原因
- 影响范围>
```
## Type 类型
- `feat`: 新功能
- `fix`: 修复问题
- `refactor`: 重构
- `perf`: 性能优化
- `docs`: 文档
- `style`: 格式
- `test`: 测试
- `chore`: 构建工具
## 要求
- **智能识别**:优先使用已 staged 的改动,如果没有则提示用户
- **标题**一行不超过50字符
- **详细说明**2-3行说明具体改动、原因和影响
- **scope**:具体模块名(如 lisa_uart, lisa_gpio
- **提交命令**
- 如果有 staged 改动:使用 `git commit -s`
- 如果没有 staged 改动且用户确认 add先运行 `git add -A`,再 `git commit -s`
- **不要**添加 Claude Code 的 Co-Authored-By 信息

View File

@@ -0,0 +1,93 @@
---
name: changelog
description: 根据 git 提交记录生成或更新 CHANGELOG.md 文件,自动分类提交并按语义化版本管理
---
# CHANGELOG 生成器
自动从 git 提交记录生成符合项目规范的 CHANGELOG.md。
## 执行步骤
1. **读取现有 CHANGELOG.md**
- 解析最新版本号(如 0.1.1
- 识别最新版本的日期
2. **获取 git 提交记录**
- 尝试查找最新的 git tag
- 如果有 tag获取从最新 tag 到 HEAD 的所有提交
- 如果没有 tag根据最新版本日期获取之后的所有提交
- 使用命令:`git log --pretty=format:"%h|%s|%b|%ad" --date=short`
3. **解析和分类提交**
- 从提交信息中提取 `type(scope): description` 格式
- 按 type 分类:
- `feat`**Added** 部分
- `fix`**Fixed** 部分
- `refactor`, `perf`, `style`**Changed** 部分
- `chore`, `docs`, `test` → 根据内容判断或忽略
- 按 scope 分组相同类型的改动
- 保留提交的详细说明body中的关键信息
4. **生成新版本内容**
- 询问用户新版本号(提供自动递增建议,如 0.1.1 → 0.1.2
- 使用当前日期YYYY-MM-DD 格式)
- 生成格式:
```markdown
## [新版本号] - YYYY-MM-DD:
- All changes since 上个版本号
### Changed:
- scope: 变更说明
### Fixed:
- scope: 修复说明
### Added:
- scope: 新增说明
### Deprecated:
```
5. **预览和确认**
- 显示生成的新版本内容
- 询问用户是否插入到 CHANGELOG.md
- 如果确认,将新内容插入到文件顶部(在 `# Change Log` 标题之后)
## 格式要求
- **缩进**:使用 2 空格缩进
- **分组**:相同 scope 的改动合并,使用子列表
- **排序**
- 部分顺序Changed → Fixed → Added → Deprecated
- 每部分内按 scope 字母排序
- **空行**:各部分之间保留空行
## 示例输出
```markdown
## [0.1.2] - 2025-01-14:
- All changes since 0.1.1
### Changed:
- drivers/lisa_uart: 防止传输过程中重新配置
### Fixed:
- drivers/lisa_gpio: 修复中断被重复触发的问题
- drivers/lisa_flash: 修复边界检测
### Added:
- boards: 新增rgb pinmux适配
- components/new_feature: 新增功能组件
```
## 注意事项
- **不要**自动 git commit 生成的 CHANGELOG
- **只处理** CHANGELOG.md 文件,不修改其他文件
- 如果提交信息格式不规范,尽量智能提取关键信息
- 对于合并提交Merge commit可以忽略或提取实际改动
- 保持与现有 CHANGELOG.md 相同的格式风格

View File

@@ -0,0 +1,168 @@
---
name: sample-doc-review
description: 使用 Samples_Spec.md 规范对示例文档进行全面审查,生成详细审查报告
---
# 示例文档审查器
基于 `samples/Samples_Spec.md` 规范对 ARCS SDK 示例文档进行全面审查,检查结构、格式、内容和语言规范性。
## 快速使用
直接在对话中使用以下任一方式触发:
```
审查 samples/modules/sys_heap/README.md
检查 lisa_gpio 示例文档
审查 sys_heap
```
## 执行步骤
### 1. 读取规范文档
**必须先读取** `samples/Samples_Spec.md` 文件,获取完整的审查标准:
- 标准章节结构和顺序
- 各章节的详细规范
- 不同类型示例的差异要求
- 格式规范
- 语言规范
- AI 审查文档清单
### 2. 确定示例文档路径
- 如果用户提供了文档路径,直接使用
- 如果用户只提供了示例名称(如 "sys_heap"),在 `samples/` 目录下搜索对应的 README.md
- 显示找到的文档路径供用户确认
### 3. 读取并分析目标文档
- 读取目标 README.md 文件
- 根据路径自动识别示例类型:
- `samples/drivers/devices/` → Devices
- `samples/modules/` → Modules
- `samples/network/` → Network
- `samples/drivers/hal/` → HAL
### 4. 执行全面检查
严格按照 `Samples_Spec.md` 中的 **"AI 审查文档清单"** 部分逐项检查:
1. **结构检查**10 项)
2. **格式检查**9 项)
3. **内容检查**8 项)
4. **语言检查**6 项)
5. **类型特定检查**(根据示例类型)
### 5. 生成审查报告
使用 `Samples_Spec.md` 中定义的 **"审查报告格式"** 生成报告:
```markdown
# 文档审查报告
**文档路径**: {文件路径}
**示例类型**: {Devices/Modules/Network/HAL}
**审查日期**: {日期}
## 审查结果
**总体评分**: {通过/需修改/不合格}
## 问题清单
### 必需修改(阻塞问题)
{列出所有阻塞问题}
### 建议优化(非阻塞)
{列出所有优化建议}
## 符合规范项
{列出所有通过的检查项}
## 总结
{总体评价和建议}
```
## 评分标准
参考 `Samples_Spec.md` 的规范,但具体标准如下:
- **通过**:无阻塞问题,建议优化 ≤ 3 个
- **需修改**:有 1-3 个阻塞问题
- **不合格**:有 >3 个阻塞问题
### 阻塞问题定义
以下属于阻塞问题(必须修改):
1. 缺少必需章节
2. 标题格式严重错误
3. 章节顺序严重混乱
4. 核心 API 章节缺失Devices/Modules 类型)
5. 代码块未标注语言
6. API 表格格式错误
其他问题归为建议优化。
## 更多触发方式
### 完整路径
```
审查 samples/drivers/devices/lisa_uart/send_async_dma/README.md
帮我审查 http 示例文档是否符合规范
```
### 使用关键词
```
使用规范审查 sys_heap 示例
对 lisa_gpio 文档进行规范检查
验证 http 示例文档的规范性
```
## 使用示例
### 示例 1: 审查指定路径
```
用户:审查 samples/modules/sys_heap/README.md
AI[读取规范] → [读取文档] → [识别类型: Modules] → [执行检查] → [生成报告]
```
### 示例 2: 根据名称查找
```
用户:审查 sys_heap 示例文档
AI找到文档samples/modules/sys_heap/README.md
类型Modules
[开始审查...]
```
### 示例 3: 批量审查
```
用户:审查 samples/drivers/devices/lisa_gpio/ 下的所有文档
AI找到 3 个文档:
- output_basic/README.md
- input_basic/README.md
- interrupt/README.md
[逐个审查...]
```
## 特别注意
1. **规范引用**:所有检查标准以 `Samples_Spec.md` 为准,不要使用过时规范
2. **类型识别**:必须正确识别示例类型,应用对应的特定检查
3. **详细定位**:问题描述要包含章节名称和行号(如果适用)
4. **具体建议**:提供可直接应用的修改示例
5. **RST 引用检查**:编译和烧录章节优先推荐使用 `.. include:: /sample_build.rst``.. include:: /sample_flash.rst`
## 特殊情况处理
- **HAL 示例**:允许使用 `📖示例说明` 替代 `功能说明`,在报告中注明即可
- **特殊编译参数**:如果示例需要特殊编译参数,允许直接写命令而非 RST 引用,但需说明原因
- **文档不存在**:提示用户并建议可能的路径