Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

79 lines (62 loc) · 3 KB

开发指南

介绍

首先感谢你关注 Vion 组件库，并进行代码贡献。 以下是关于向 Vion 提交代码的指南。在向 Vion 提交 Issue 或者 MR 之前，请先花几分钟时间阅读以下文字

Issue 规范

  • 遇到问题时，请先确认这个问题已经在 issue 中有记录或者已被修复
  • 提 Issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤

Commit Message格式规范

  • feat: 新特性
  • fix: 修改问题
  • refactor: 代码重构
  • docs: 文档修改
  • style: 代码格式修改, 注意不是 css 修改
  • test: 测试用例修改
  • chore: 其他修改, 比如构建流程, 依赖管理

Merge Request 规范

  • 如果遇到问题，建议保持你的 MR 足够小。保证一个 MR 只解决一个问题或只添加一个功能
  • 当新增组件或者修改原有组件时，记得增加或者修改测试代码，保证代码的稳定
  • 在 MR 中请添加合适的描述，并关联相关的 Issue

Merge Request 流程

  1. 从主仓库中Fork一份到自己的代码仓库
  2. 新建开发分支，分支规范要求如下：
    • 修复组件 bug，分支命名形式为 bugfix/[组件名]_[问题简称] ，如：bugfix/button_color
    • 新增全新组件，分支命名形式为 feature/[组件名]，如：feature/button
    • 新增组件特性，分支命名形式为 feature/[组件名]_[功能]，如：feature/button_loading
  3. 在新分支上开发完成后，提 Merge Request 到仓库的 dev 分支
  4. Merge Request 会在 Review 通过后被合并到仓库 Master 分支

目录结构

  • 仓库的组件代码位于 src 下，每个组件一个文件夹
  • site 目录下是文档网站的代码，本地查看网站效果时可以在目录下运行 npm run dev 开启文档网站

项目目录大致如下：

├─ script    # 构建脚本
├─ lib       # 产物
├─ es        # ESM产物
├─ docs      # 文档
├─ src       # 组件
├─ site      # 网站
├─ types     # 类型定义

添加新组件

添加新组件时，请按照下面的目录结构组织文件，并在 site/[demo|docs]/config.js 中配置组件名称及相关信息。运行npm run dev即可以打开浏览器查看组件示例了。

src
|- button
|  ├─ __test__         # 单元测试
|  ├─ demo             # 示例代码
|  ├─ button.vue       # 组件源码
|  ├─ index.js         # 组件入口
|  ├─ style.js         # 样式入口
|  ├─ README.md        # 组件文档
|
|- style
|  ├─ button.less      # 组件样式
|
├─ index.js            # 所有组件入口
├─ index-es.js         # ESM组件入口
├─ config.js           # 配置文件

关于相关命名规范

  • 样式的 class 必须以v-作为前缀，并遵循BEM命名规范
  • 组件 API 命名尽可能语义简洁，不能带有业务含义