Main
让规则贴近代码:把规则文件随仓库提交(Cursor
.cursor/rules/、Copilot instructions),确保全团队共享一致约束。从小开始:先选 1–2 条关键规则(脚手架 + 代码风格),能解释“它解决了什么失败模式”后再加更多。
多工具并行时,把 README 的映射表当作接口契约(Cursor/Copilot/Zed/Windsurf/Cline),有意识地维护一致性。
Source-backed notes
- README 给出工具映射表:Cursor 用
.cursor/rules/,Copilot 用.github/copilot-instructions.md,Windsurf 用.windsurfrules,Zed 用.zed/。 - README 表示该仓库收集提示词、最佳实践与规则,帮助开发者快速搭建并迭代 AI 编码工作流。
- README 说明贡献方式:在
prompts/<name>下放元数据(aiprompt.json)与.mdc规则文件。
FAQ
- 必须用 Cursor 才能用吗?:不必。README 列出多种工具;同一套规则思路可迁移使用。
- Copilot 指令文件放哪里?:按 README:在仓库根目录创建
.github/copilot-instructions.md。 - 如何避免规则过载?:把规则当代码管理:版本化、评审、小步扩展,避免一次性堆满。