compose-agents-md

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Compose AGENTS.md Skill

Compose AGENTS.md 技能

Help the user create an

AGENTS.md

for their project.

帮助用户为其项目创建

AGENTS.md

文件。

Step 1 — Understand the Project

步骤1 — 了解项目

Ask (if not already known):

What language(s) does the project use?
What architectural pattern (hexagonal, microservices, BFF, monolith)?
What is the primary purpose of the project?
Which AI vendors are used on this project?

询问（若尚未了解）：

项目使用什么编程语言？
采用何种架构模式（六边形架构、微服务、BFF、单体架构）？
项目的主要用途是什么？
项目使用了哪些AI供应商？

Step 2 — Recommend a Profile

步骤2 — 推荐配置文件（Profile）

Check

just list-profiles

to show available profiles.

Match the user's answers to an existing profile. If a match exists:

bash

just compose {profile-name} {/path/to/target-project}

If no profile matches closely enough, offer to: a) Compose from individual fragments (guided selection) b) Create a new profile for this project type

执行

just list-profiles

查看可用的配置文件。

将用户的回答与现有配置文件匹配。若找到匹配项：

bash

just compose {profile-name} {/path/to/target-project}

若没有足够匹配的配置文件，提供以下选项： a) 从独立片段组合生成（引导式选择） b) 为此项目类型创建新的配置文件

Step 3 — Fragment Selection (if no profile matches)

步骤3 — 片段选择（无匹配配置文件时）

Guide the user through selecting fragments:

Base fragments (always recommended):

```
git-conventions
```
— always include
```
security
```
— always include
```
code-review
```
— include if team does code reviews
```
testing-philosophy
```
— include if testing standards matter
```
documentation
```
— include if docs standards matter

Language: pick from

agents/languages/

Architecture: pick from

agents/architecture/

Practices: pick from

agents/practices/

Domain: pick from

agents/domains/

if a match exists

引导用户选择片段：

基础片段（建议始终包含）：

```
git-conventions
```
— 始终包含
```
security
```
— 始终包含
```
code-review
```
— 若团队进行代码评审则包含
```
testing-philosophy
```
— 若重视测试标准则包含
```
documentation
```
— 若重视文档标准则包含

语言：从

agents/languages/

中选择架构：从

agents/architecture/

中选择实践：从

agents/practices/

中选择领域：若有匹配项，从

agents/domains/

中选择

Step 4 — Compose and Deploy

步骤4 — 组合生成与部署

Run the compose and vendor-gen commands:

bash

just compose {profile-or-custom} {target-path}
just vendor-gen {target-path}

执行compose和vendor-gen命令：

bash

just compose {profile-or-custom} {target-path}
just vendor-gen {target-path}

Step 5 — Verify

步骤5 — 验证

Open

{target-path}/AGENTS.md

with the user and confirm:

The content accurately represents the project's standards
Build/test/lint commands are correct
No placeholder tokens (
```
{{TOKEN}}
```
) remain unfilled

与用户一同打开

{target-path}/AGENTS.md

并确认：

内容准确反映项目的标准
构建/测试/代码检查命令正确无误
无未填充的占位符标记（
```
{{TOKEN}}
```
）