Skip to content

Latest commit

 

History

26 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ai-dev-rules

ai-dev-rules 用于集中维护 AI 编程规范、场景化执行指令和 Codex 桌面端主题,避免把规则分散在不同项目或全局配置中。

目录结构

ai-dev-rules/
├── ai-rules/
│   └── coding-standards.mdc  # 通用编码规范和协作约定
├── ai-instructions/
│   └── bugfix.md             # AI 批量排查和修复 Bug 的执行指令
└── ai-theme/
    ├── apply.bat             # 实时应用 Codex 主题
    ├── pause.bat             # 移除主题并恢复原生界面
    ├── src/                  # 样式生成和无重启注入代码
    └── theme/                # 主题配置及图片资源

开发规范

ai-rules/coding-standards.mdc 是日常开发任务唯一需要 AI 主动读取的规范文件,包含通用编码规范、协作约定、多项目识别方式和按技术栈生效的专项规则。

使用方式

ai-dev-rules 放到你的工作目录里,和业务项目同级即可。

在 Codex 全局指令中只配置规则入口和读取时机,具体编码要求统一在 coding-standards.mdc 中维护。

Codex 全局指令示例

默认使用中文沟通,回答先给结论,再给关键原因。

默认由当前会话直接处理,不主动使用子代理或任务委派。
仅当用户明确要求,或任务可拆分为互不依赖、不修改同一文件且不影响同一接口或共享契约的独立子任务时,才使用子代理;主会话负责最终整合和确认。

不要在每个新会话自动读取编码规范。
当任务涉及本地项目源码、配置或脚本的排查、修改、实现、重构、故障诊断或 review 时,读取:
D:\work\ai-dev-rules\ai-rules\coding-standards.mdc

普通聊天、概念解释、资料查询、Git 操作、文件传输、环境查询及不修改配置的 Docker 操作,不加载编码规范。

如果用户给出了项目路径,以该路径作为当前项目。
如果用户只给出文件路径,以该文件所在仓库作为当前项目。
处理本地项目时,读取项目根目录到目标文件路径之间的 `AGENTS.md`。
存在多层项目规范时,以距离目标文件最近的规范为准。
项目规范与通用编码规范冲突时,以项目规范为准。
全局指令中不固定具体项目名称或项目绝对路径。

对于解释、咨询、诊断、排查和 review 请求,默认只读分析,不修改文件。
对于明确要求修复、实现、重构或修改的请求,直接完成需求范围内的修改。
需要扩大修改范围时,先说明原因和影响。

配置原则

  • 全局指令只负责规则路由、项目识别和修改权限。
  • 具体编码规范统一放在 coding-standards.mdc 里维护。
  • 涉及本地工程时,先读通用规范和项目内 AGENTS.md,再按就近优先原则执行;普通聊天不加载规范。

场景化指令

ai-instructions/bugfix.md 用于 AI 批量读取问题清单、定位代码并执行修复。它是特定任务的执行模板,不属于每次开发都要加载的通用规范。

Codex 主题

ai-theme 是独立的 Codex 桌面端主题源码,采用运行时注入,不需要安装到 Codex,也不会修改 Codex 安装目录。

  • 运行 ai-theme/apply.bat:向当前 Codex 窗口实时应用主题,无需重启。
  • 运行 ai-theme/pause.bat:移除主题并恢复原生界面。
  • 修改 ai-theme/theme:调整主题配色、背景和装饰图片。

Codex 更新或完全退出后,运行时注入会被清除,需要再次运行 apply.bat。该目录是附加工具,普通代码任务不需要读取。

License

MIT

About

一套给多种 AI 编程助手共用的开发规范仓库。

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages