基本指南

[danranVm]

Vue 3.0 的发布带来了完整的 TypeScript 开发体验，全新的 Composition Api, 以及其他的各种新特性 现有的内部组件库承载了许多它本不应该承载的功能，已经日渐膨胀，变得难以维护 积重难返，我们决定扔掉技术包袱，重新设计并开发一套全新的组件库

✨ 特性

• Monorepo 管理模式：cdk, components, pro
• 全面拥抱 Composition Api，从源码到文档
• 完全使用 TypeScript 开发，提供完整的类型定义
• 开箱即用的 Tree Shaking
• 高覆盖率的单元测试
• 国际化语言支持
• 灵活的全局配置
• 深入细节的主题定制能力

📓 版本规范

• 严格遵循 Semantic Versioning 2.0.0 语义化版本规范
• 发布周期(1.0版本发布后实行)
  • 修订版本号：每周末会进行日常 bugfix 更新（如果有紧急的 bugfix，则任何时候都可发布）
  • 次版本号：每月发布一个带有新特性的向下兼容的版本
  • 主版本号：含有破坏性更新和新特性，不在发布周期内

🤝 协作指引

• 贡献指南
• 开发流程
  • 所有 Feature 和 Bugfix 都需要建立 Issue
  • Feature 需要进行设计和讨论
  • 编码
  • CI：Lint, Test, Preview
  • Code Review

🎨 代码风格

我们使用了 eslint, stylelint, markdownlint 以及 ls-lint 来保证整体的代码风格一致。 并且在 commit hooks 中配置了自动格式化和 lint, 只要提交通过即可。

📚 文档内容

• 基本介绍
• 何时使用
• API 说明
• 代码演示
• 如何使用（可选）
• FAQ（可选）

✅ 单元测试

• Public Api 必须覆盖

• 覆盖率要求：85%

  // jest coverageThreshold
  {
    branches: 85,
    functions: 85,
    lines: 85,
    statements: 85,
  }