仓库上手与约定读取
大约 2 分钟
第四章:让 Claude 快速读懂仓库:约定、入口、边界
4.1 “仓库上手速度”决定 Claude 的产出上限
Claude Code 会读你的代码,但它并不知道你团队的约定:
- 代码风格、目录结构、分层规则
- 测试如何运行、lint 如何运行、构建如何运行
- 哪些文件可以改、哪些文件严禁改
- 是否允许新增依赖、是否允许改 DB 结构
你把这些说清楚,Claude 的产出会更稳定、返工更少。
4.2 第一次进入仓库的标准提示(可直接复制)
你正在一个新的代码库中协助我开发。
请先做“仓库上手”而不是直接改代码:
1) 阅读 README/CONTRIBUTING(如果有)
2) 找出:应用入口、核心模块、测试命令、lint/format 命令
3) 总结项目约定(分层/命名/目录结构)
4) 给出你建议的工作流:改动→验证→交付(用 /diff)
约束:
- 不要新增依赖,除非我明确要求
- 不要修改配置与基础设施目录(例如 infra/、deployment/)
- 任何改动都必须跑测试与 lint(如果项目提供)4.3 把“验收命令”写清楚(这是最值钱的一句)
Claude 很擅长改代码,但如果你不告诉它“如何验证正确”,它会把你带进玄学:
- Node:
npm test、npm run lint、npm run build - Java:
mvn test、mvn -q -DskipTests=false test - Python:
pytest -q、ruff check .、mypy .
当你不确定项目命令时,让 Claude 先查再跑:
先从 package.json / pom.xml / pyproject.toml 找到正确的测试与 lint 命令,再用 /run 执行。4.4 明确边界:哪些目录可以改,哪些目录不要碰
建议你用一句话把边界写死:
只允许修改 src/ 与 tests/;禁止修改 .github/、infra/、deployment/、terraform/。这会极大降低“改动扩散”的风险。
4.5 本章小结
你已经掌握了“仓库上手”的关键要领:
- 先让 Claude 总结项目约定与入口
- 把验收命令写清楚,避免玄学
- 把修改边界写死,降低风险
下一章我们进入最能提升效率的部分:如何写高质量提示词,让 Claude 输出稳定、可控、可验证的改动。
