LabelingSystem/.kiro/steering

项目开发规范

本目录包含项目的所有开发规范和最佳实践。

规范文档

后端开发

• python-后端规范.md - Python/FastAPI 后端开发规范
  • 项目结构
  • 代码风格（PEP 8）
  • FastAPI 最佳实践
  • 数据库操作
  • 错误处理
  • 测试文件管理

前端开发

• react-组件规范.md - React 组件开发规范

  • 组件结构
  • Hooks 使用
  • 状态管理（Jotai）
  • 性能优化
  • 代码组织
  • 包导入规范

• typescript-前端规范.md - TypeScript 最佳实践

  • 类型系统
  • 命名约定
  • 函数定义
  • 错误处理
  • 泛型使用

• tailwind-样式规范.md - Tailwind CSS 样式规范

  • 组件样式
  • 设计令牌（Tokens）
  • 布局和排版
  • 颜色使用
  • 响应式设计

第三方集成

• labelstudio-集成规范.md - LabelStudio 编辑器集成规范 ⭐
  • Webpack 配置（CSS 前缀）
  • 样式导入策略
  • 组件实现模式
  • 常见问题解决
  • 调试技巧
  • 最佳实践

快速查找

遇到样式问题？

→ 查看 labelstudio-集成规范.md 的"常见问题和解决方案"部分

需要创建新组件？

→ 查看 react-组件规范.md 的"组件结构"部分

需要添加 API 端点？

→ 查看 python-后端规范.md 的"FastAPI 最佳实践"部分

需要使用 Tailwind 样式？

→ 查看 tailwind-样式规范.md 的"设计令牌"部分

重要提示

1. 所有开发人员必须遵循这些规范
2. 遇到问题先查看相关规范文档
3. 发现新的最佳实践请更新相应文档
4. 使用中文与用户对话

规范更新

如果你发现了新的最佳实践或解决方案：

1. 更新相应的规范文档
2. 添加具体的代码示例
3. 说明问题的根本原因
4. 提供验证方法
5. 更新本 README 的快速查找部分

联系方式

如有疑问或建议，请联系项目维护者。