用途:为代码的编写与组织提供通用约定。当需要新建文件、决定模块(组件、hook、工具、server action、类型等)位置、命名文件或导出、编写导入、运行项目命令(安装、构建、测试、脚本)或添加注释时查阅。若项目已明确遵循其他约定,则匹配项目并说明。
主要能力: 文件放置与就近原则:把每个功能/路由文件夹视为自包含单元,默认就近放置,仅在真正广泛使用时提升为全局。按使用范围决定:单一功能使用则留在该功能文件夹内(如本地 components/、hooks/、actions/、lib/);少数同级功能共享则提升到最近的共同祖先文件夹;真正全局使用才放根级共享文件夹。设计系统/UI 基础组件(如 components/ui/)始终全局;第三方服务初始化/配置客户端(数据库、邮件、向量库、队列、分析等)属于全局共享文件夹。功能组件即使被外部导入,只要未广泛共享仍可就近放置。 工具与导入:所有项目命令使用 pnpm(安装、运行脚本、增删依赖),除非项目明显使用 npm/yarn。非相对导入使用项目路径别名(常见 @/),匹配项目已配置的别名。 命名:文件用 kebab-case;React 组件用 PascalCase;仅用命名导出,避免默认导出(框架要求的路由/页面入口文件除外)。 注释:对非显而易见的假设、产品特定逻辑、仓库特定机制或非行业标准之处,留一句简短行内注释;不要添加仅复述代码的注释。
使用方式:在相关操作前逐条阅读约定,若匹配则应用;项目已有不同约定时以项目为准并说明。
限制:该技能会随时间增长,新约定应添加在 Conventions 部分,并以可机械应用的规则表述。资料未提供具体安装命令、收费或平台信息。