关于 engram-project-structure
面向 Engram 贡献者的项目结构技能，帮助判断代码和文件应放置的位置。它针对仪表板、服务端和存储层变更提供目录规则、文件创建指引及反模式说明。
主要功能
- 01按领域放置代码
- 02仪表板模板与资源目录规则
- 03路由和数据库变更指引
- 04界面组件及生成文件规则
- 05架构反模式说明
适用场景
- 01为新功能选择代码包
- 02添加带专项测试的路由
- 03创建仪表板页面或局部视图
- 04避免在处理器中编写持久化逻辑
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/engram-project-structure确认已加载。
详细介绍
适用场景
在以下情况下使用此技能：
- 创建新的包、文件或目录
- 决定代码的存放位置
- 添加测试、模板、资源或文档
存放规则
- 将行为放在其所属领域附近，而不是放在碰巧调用它的代码附近。
- 将模板放在
internal/cloud/dashboard/*.templ中，并将生成的文件一并检入版本控制。 - 除非明确需要新的静态资源，否则将仪表板样式放在
internal/cloud/dashboard/static/styles.css中。 - 将 HTTP 处理程序放在服务端包中，而不是存储包中。
- 将持久化查询放在 store/cloudstore 中，而不是处理程序中。
文件创建规则
- 新路由 -> 在 dashboard/server 包中添加处理程序和测试
- 新数据库行为 -> 添加 store/cloudstore 代码和针对性测试
- 新 UI 局部组件/页面 -> 添加 templ 组件和生成的
_templ.go - 新的贡献者指南 -> 在同一次变更中更新 docs/catalog
反面模式
- 不要在一个文件中混合 SQL、HTML 和传输逻辑。
- 不要为一次性辅助函数创建工具包。
- 除非能消除实际耦合，否则不要添加包层级。
评论
支持 Markdown