用途:project-conventions 是一个面向代码库的约定文档模板,属于技能(Skill)形式,用于向智能体说明本项目应遵循的核心约定与模式。资料指出,技能的作用是让智能体学习代码库特定的实践,因此此处记录得越准确,智能体的输出质量越高。
主要能力:模板给出了若干待填充的约定类别,包括错误处理、测试、代码风格、文件结构,以及示例与反模式(Anti-Patterns)。每个模式以“[Pattern Name]”占位,要求具体说明在本代码库中应做什么以及为什么这样做;反模式部分则要求说明不应做什么及其原因。
使用方式:资料将其定位为起始模板(starter template),需要把下方的占位模式替换为实际的项目约定。示例部分预留了代码示例位置,用于演示约定。资料未提供安装命令、调用方式或具体运行步骤。
适用场景:适合作为新项目或已有项目整理编码规范的起点,也可作为智能体上下文,使其在生成代码时遵循项目既有风格与结构。
限制:当前内容全部为占位文本,未包含任何真实约定、具体规则或可执行示例;资料未说明其支持的平台、依赖、收费情况或实际效果。