最新

AI 编程助手怎么配置项目规则

让 AI 遵守你的代码风格和目录约定,靠的不是每次叮嘱,而是仓库里的规则文件。写什么、写多细。

AI 编程助手默认按「通用最佳实践」写代码:新建一堆你没用过的目录、引入不需要的依赖、用和你项目不一致的命名。解决办法是在仓库里放一份规则文件,让它每次先读。

规则文件放哪

  • Cursor:项目根目录的 .cursor/rules 或 .cursorrules。
  • Claude Code:项目根目录的 CLAUDE.md。
  • 通用约定:AGENTS.md,越来越多工具支持。
  • GitHub Copilot:.github/copilot-instructions.md。

该写什么

  1. 技术栈与版本:框架、语言版本、包管理器,明确到不能用什么。
  2. 目录结构:哪一层放什么,新文件该建在哪。
  3. 常用命令:安装、启动、测试、格式化,让它知道怎么验证改动。
  4. 代码约定:命名风格、错误处理方式、日志规范、注释语言。
  5. 禁止事项:不要改数据库迁移文件、不要新增依赖、不要动某个目录。

写多细合适

  • 一页以内最好。太长的规则文件模型会忽略后半部分。
  • 用命令式短句,不要写背景故事。
  • 把「必须」和「建议」分开写,模型对强约束的遵守率更高。
  • 遇到反复犯的错,就补一条进去,规则文件是迭代出来的。

配合工作流

  • 一次只让它改一个文件或一个功能,改完立刻跑测试。
  • 提交前自己看 diff,AI 会顺手改掉不相干的代码。
  • 让它先输出计划再动手,能减少大范围误改。
  • 测试失败时把完整报错贴回去,比描述「报错了」有效得多。

常见问题

规则写了它还是不听?

检查文件是否在项目根目录、工具是否真的读取(部分工具需要显式引用)。也可以在对话开头让它复述一遍规则。

多人协作怎么维护?

规则文件和代码一起进版本库,改动走 review。规则冲突比代码冲突更隐蔽。

一句话总结:技术栈、目录、命令、禁止项四块写进根目录规则文件,一页以内,边用边补。