Skip to content

Components rules #3

@laozhu

Description

@laozhu

为保证每一个组件独立,不相互依赖,需要遵守下面规则:

  1. 组件仅允许引入已定义的公共样式和组件样式
  2. 组件需严格定义接口参数类型及其默认值
  3. 组件需包含文档,约定位于组件目录下 readme.md 文件
  4. 组件需包含测试用例,约定位于 __tests__ 目录下
  5. 组件中可引入流行的工具类库(如:lodash, classnames 等)
  6. 引入工具类库的组件单独打包时需抽离依赖,写入 package.json
  7. 代码风格需遵守 @pubean/eslint-config@pubean/stylelint-config
  8. 如对代码风格有异议,可先提出讨论后修改规则
  9. 使用不符合浏览器兼容性要求特性需在 package.json 中明确添加忽略

@chekun

Metadata

Metadata

Assignees

No one assigned

    Labels

    rulesRules discussed here

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions