配置生成器

AGENTS.md 生成器

记录代理应该如何检查、编辑、测试并交接你的代码仓库。

最后更新: 2026年6月12日

AGENTS.md
# Agent Instructions

Use this file to guide coding agents working in this repository.

## Project Context

- Project type: Next.js
- Tech stack: Next.js, TypeScript, React, CSS modules
- Coding style: Prefer small components, explicit types, accessible UI, and existing project patterns.
- AI tool target: AGENTS.md 生成器

## Project Commands

- Package manager: npm
- Test: `npm test`
- Build: `npm run build`
- Lint: `npm run lint`

## Working Agreement

- Read nearby files and reuse established project patterns.
- Make small, reviewable changes.
- Do not introduce new dependencies unless they clearly reduce complexity.
- Keep user-facing text concise and accessible.
- Preserve unrelated user changes in the working tree.

## Validation

1. Run `npm run lint` for style and static checks.
2. Run `npm test` for behavior.
3. Run `npm run build` before release or handoff.

## Extra Instructions

Before handoff, summarize changed files and mention any checks that could not be run.

使用 AGENTS.md 生成器记录编码代理在仓库中应该如何检查、编辑、测试和交接。多个代理或自动化工具需要同一份项目上下文时,这个文件尤其有用。

AGENTS.md 为什么有帮助

AGENTS.md 为代理工作流提供可移植的事实来源。它可以描述仓库布局、验证命令、安全期待,以及任务后如何总结改动。

最佳实践

保持指令稳定,避免密钥,并优先使用开发者本地可运行的命令。如果命令很慢,同时记录定向检查和完整发布检查。

常见问题

AGENTS.md 是工具专属的吗?

不是。它适合作为不同编码代理之间可复用的指令文件。

AGENTS.md 应避免什么?

避免私有 token、空泛风格口号和已经失效的命令。