ciembor/agent-rules-books

AGENTS.md rules / skills for AI coding agents: Codex, Cursor & Claude Code. Inspired by Clean Code, Refactoring, DDD, Clean Architecture and DDIA programming books.

What it solves

它提供了一个为 AI 编码代理程序(例如 Cursor, Claude Code, 和 Codex)准备好的、即刻可用的规则集和“技能”库,以确保它们遵循既定的软件工程原则。这个项目并不只是简单地告诉代理程序“遵循 Clean Code”,而是提供具体的、提炼出的指令,以防止代理程序在重构与开发过程中做出错误的架构决策或忽略行业标准的设计模式。

How it works

本项目将经典软件工程书籍(例如 Clean Code, Domain-Driven Design, Refactoring)的核心原则提炼成与工具无关的 Markdown 格式文件。这些规则提供三种尺寸,以平衡细节与上下文窗口(context window)限制:

  • Full: 完整的参考版本。
  • Mini: 大多数任务的推荐版本。
  • Nano: 针对上下文预算(context budgets)极其有限的情况提供的精简版本。

用户可以使用 CLI 工具 (npx skills) 安装这些规则作为“技能”,或者手动将它们添加到项目特定的指令文件,例如 AGENTS.mdCLAUDE.md

Who it’s for

使用 AI 编码助手的使用者,希望其代理程序能基于已证实的架构模式,而非仅仅依赖代理程序的默认(且有时不一致)的行为,来产出出更高质量、更具可维护性的代码。

Highlights

  • Comprehensive Library: 涵盖了广泛的领域,包括 DDD, Clean Architecture, legacy code handling, 和 data-intensive systems。
  • Context-Aware Sizing: 提供不同的规则密度(Full, Mini, Nano)以优化 token 使用量。
  • nTool Agnostic: 兼容于主要的 AI 编辑器和代理程序,包括 Cursor, Claude Code, Codex, 和 GitHub Copilot
  • Empirically Tested: 包含一个验证实验,显示提供具体的规则比起单纯- 命名一本著作,能显著提升架构决策的判断力。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目