用途:这是 Kiso 组件库的贡献与开发流程指南,帮助贡献者确定构建、审查和发布组件时应参考的文档与规范。
主要内容:文档按主题指向对应文件,包括组件创建(project/component-creation.md)、组件审查的 12 点清单(project/component-review.md)、设计系统规则(project/design-system.md)、架构模式与 ClassVariants(project/component-strategy.md)、按插槽 ui: 覆盖的 ADR(project/decisions/004-per-slot-ui-prop.md)、测试策略、组件文档模板,以及 CLAUDE.md 中的命名与代码规则。
使用方式:新组件可用 bin/rails generate kiso:framework_component name 生成初始文件,再填写主题与 partial。项目结构涵盖 lib/kiso/themes 的 Ruby 主题模块、app/views/kiso/components 的 ERB partial、app/assets/tailwind/kiso/engine.css、app/helpers/kiso 的 kui() 等辅助方法、Stimulus 控制器、Lookbook 预览、docs 站点及 lookbook 开发应用。CSS 上 engine.css 承载 Geist 字体、默认颜色 token、暗色模式覆盖与 @source 指令,颜色 token 不应放入 Lookbook 的 application.css。
常用命令:bin/dev、bin/worktree start、bundle exec rake test、npm run test:unit、npm run test:e2e、bundle exec standardrb --fix、npm run lint、npm run fmt。PR 正文需写 Closes #N 以便合并时自动关闭 issue。提交时按具体文件 git add,不要使用 git add -A。国际化文本使用 t('kiso.component_name.key')。
限制:资料未说明该指南的具体版本、支持平台或收费情况。