agentleFS
iPythoningiPythoning/b2b-sdr-agent-template/AGENTS.md

b2b-sdr-agent-template

AGENTS.md191 starsChanged 5 months agoMITView on GitHub

本文件是本仓库的*唯一权威协作守则*,对所有厂商的 coding agent(Claude Code / Codex / Cursor / Gemini / Windsurf / Kimi 等)一视同仁。 CLAUDE.md、GEMINI.md、.cursorrules 等厂商文件只是指向本文件的指针;冲突时以本文件为准。 (项目职责与架构说明待补充) 如命令变更,必须同步更新本节——这是所有 agent 的共同基线。 冲突裁决:架构边界按长期设计,边界之内的实现按当前最简。 安全红线:绝不提交密钥、证书、证件与客户隐私数据;发现仓库中已存在此类文件时,先报告,不静默处理。

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    commit 前 git diff --stat 确认无意外的 Dockerfile / nginx.conf / docker-compose.yml 变更;基础设施文件单独 commit。

    line 39

≈ “Common” is an estimate: at least 1 in 5 of the 42,283 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md — b2b-sdr-agent-template

本文件是本仓库的唯一权威协作守则,对所有厂商的 coding agent(Claude Code / Codex / Cursor / Gemini / Windsurf / Kimi 等)一视同仁。 CLAUDE.md、GEMINI.md、.cursorrules 等厂商文件只是指向本文件的指针;冲突时以本文件为准。

项目速览

(项目职责与架构说明待补充)

开始工作前:接续三步(必做)

  1. 按固定顺序阅读:README* → AGENTS.md → docs/HANDOFF.md → docs/adr/ → git log -10 --oneline
  2. 先跑一次下方验证命令,确认基线是绿的。基线红 → 先修基线,绝不在红基线上叠改动。
  3. 用自己的话复述当前任务与验收标准,确认与 HANDOFF 一致后再动手。

结束工作前:收尾三件套(必做)

  1. 跑完整验证命令,确认全绿。
  2. 更新 docs/HANDOFF.md:当前目标 / 已完成 / 进行中(含文件与位置)/ 已知坑 / 下一步 / 验证方式。
  3. 提交 git:不留未提交的半成品;commit message 用 Conventional Commits 并写清"为什么"。

验证命令(共同基线)

  • 测试:npm test

如命令变更,必须同步更新本节——这是所有 agent 的共同基线。

决策记录(ADR)

  • 任何"为什么这么改"的架构 / 方案决策,写入 docs/adr/,格式见 docs/adr/0000-template.md。
  • 对话里想通但没落盘的决策,等于没发生过。

Git 纪律

  • 禁止 git add -A:只用 git add -u 或逐文件 git add <path>;新文件必须显式 add。
  • commit 前 git diff --stat 确认无意外的 Dockerfile / nginx.conf / docker-compose.yml 变更;基础设施文件单独 commit。
  • 小步提交,一个 commit 只做一件事;一个任务一个分支。

反模式(禁止)

  • ❌ 把关键上下文写进 .claude/、.cursor/ 等厂商私有目录
  • ❌ 依赖对话摘要 / 上下文压缩传递状态
  • ❌ 在测试红的状态下继续叠新功能
  • ❌ 一次性做超出"半天能讲完"粒度的任务再交接

工程原则

  • 不保留向后兼容:删除过时路径,而不是加兼容层、回退或迁移代码。
  • 选择能完全满足当前需求的最简实现;避免投机性的抽象、配置与间接层。
  • 分层演进:从端到端能跑通的最小版本开始,在"已经能用"的基础上叠加新能力;绝不用半成品复杂度替换能用的产品。
  • 保持组件模块化,关注点清晰分离。
  • 优先采用成熟且维护良好的库(能降低整体复杂度或提升可靠性时);无明确理由不重复实现常见功能。
  • 先用项目里已有的依赖,再考虑自己实现或新增包;在查文档和类型定义之前,不要假设某个库缺少某能力。
  • 架构决策面向长期;不接受"只能应付现在、注定以后替换"的临时方案。

冲突裁决:架构边界按长期设计,边界之内的实现按当前最简。

安全红线:绝不提交密钥、证书、证件与客户隐私数据;发现仓库中已存在此类文件时,先报告,不静默处理。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.