PR.md

PR 流程

1. 明确类型

明确所新增的工具函数所操作的类型，在对应的源码目录下新增源码文件。

目前已有类型：

array, object, string, number, core, dom, bom...

2. 代码风格

如果新增是一个独立的工具函数，函数名应该尽可能遵循以下原则，保持 API 的统一性。

格式：$<动词><其他描述名词>

动词：
  1. $: 使用$为了尽可能减少与非本函数库名词冲突
  2. 动词：
    - is: 判断是否是...,一般返回布尔类型
    - get: 取值操作
    - set: 设置操作
    - which: 对应一种输入多种输出的可能性

必须保证 Lint 没有报 warning 或者 error，否则后面无法提交代码。

3. 导出

别忘记导出新增函数。

4. 测试

本项目使用 Jest 进行测试，在 test 目录下添加测试用例，应尽可能做到100% 覆盖率。

5. 添加文档

在docs/TODO.md文件下添加待合并文档说明。

6.提交代码

commit message 必须严格按照如下格式，否则可能导致 commit 不成功。

<type>(<scope>): <subject>

1. type — 提交 commit 的类型

   • feat: 新功能
   • fix: 修复问题
   • docs: 修改文档
   • style: 修改代码格式，不影响代码逻辑
   • refactor: 重构代码，理论上不影响现有功能
   • perf: 提升性能
   • test: 增加修改测试用例
   • chore: 修改工具相关（包括但不限于文档、代码生成等）
   • deps: 升级依赖

2. scope — 修改文件的范围，可选，包括但不限于 doc / plugins 等

3. subject — 用一句话清楚的描述这次提交做了什么