# rest-dev-ai-agent

**Repository Path**: restgroup/rest-dev-ai-agent

## Basic Information

- **Project Name**: rest-dev-ai-agent
- **Description**: REST 开发者 AI Code Agent 规则合辑
- **Primary Language**: Unknown
- **License**: CC-BY-SA-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-05-11
- **Last Updated**: 2026-05-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# REST 开发者 AI Code Agent 规则合辑

**该文档为人类阅读，并非交给 AI 读取**

开发者自愿分享的存储 REST 开发者为 AI Code Agent 准备的规则、开发边界、工具与最佳实践 (以下统称为规则)。

> ~~暴论：这里放的是在坐各位的 AI 炼化小人~~

并不是开发者一定要依照该项目的规则使用 AI Code Agent。这里的内容仅仅是参考。

- 如果您认为这里提到的一些规则有用，但又不想完全照搬该项目，请活用超链接功能，将有用的规则链接到您自己工作中。
- 本项目需要尽可能组织成通常 Code Agent 读取的格式。
- 与 rest-doc (用户与开发者文档) 不同，如果开发者维护的是自己发起的规则，将基本不会作审核。**这也意味着如果不同贡献者提供了相互矛盾的开发模式或规则，我们不作任何保证与检查**。
- 如果开发者打算更改其它人提供的规则，需要进行一定程度的审核。
- 如果您不希望使用特定规则，请考虑在**子目录**下新建 .gitignore 文件。本项目的子目录 .gitignore 是不被 git track 的。

> - AI agent 使用现在还在很早期的试验。这里的元规则也随时会发生变化。

尽管本项目不要求或建议开发者完全照搬，但下述流程是一个开始。

## 如何使用

- 请将该程序下载到 rest_workspace 目录下

    ```bash
    git clone https://gitee.com/restgroup/rest-dev-ai-agent.git $REST_HOME/rest-dev-ai-agent
    ```

- 取决于您的 Code Agent，将该文件夹更改为 `$REST_HOME/.config` 或 `$REST_HOME/.claude`。

- 一般建议从 `$REST_HOME` 作为根目录，开展 AI Code Agent 相关的开发工作。

## 通常的目录结构

大多数时候，我们将向项目增加 agent skills。请在 `skills` 目录下为每个 skill 创建一个子目录，并在该子目录下创建一个 SKILL.md 文件。大体上按照 [agentskills.io](https://agentskills.io/home) 的格式编写 skill：

```
my-skill/
├── SKILL.md          # Required: metadata + instructions
├── scripts/          # Optional: executable code
├── references/       # Optional: documentation
├── assets/           # Optional: templates, resources
└── ...               # Any additional files or directories
```

在编写的 SKILL.md 文件中，需要引入下述 yaml metadata (VSCode 对该文件会有格式检查)：

```
---
name: skill-name
description: A description of what this skill does and when to use it.
---
```