开发前

对于不同平台之间，默认的换行符不同导致的 eslint 问题。需要你对 git 进行设置

git config core.safecrlf true
git config core.autocrlf input

也就是说以后提交代码，对于是 CRLF 换行符的在提交时会转换成 LF.

开发规范

JSDOC 注释必须写好对应参数的类型和返回值类型，这会让编辑器识别并提供上下文提示。

示例如下:

/**
 * 写好这个函数的功能
 * @param a {string}
 * @param b {number}
 * @param b {{flag: boolean, id: string}}
 * @return {(function())|*}
 */
function test(a, b, b) {
  return function () {
    // xxxxxx
  }
}

提交规范

必须满足/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types|build)?: .{1,50}/正则表达式, revert 会在你还原历史记录时自动添加。

提交功能

feat: xxxxxx

修复 bug

bug: xxxxxx

文档添加

docs: xxxx

性能优化

perf: xxxx

添加测试

test: xxx