请先观看
项目中含有 ESLint, 不通过 ESLint 可能无法发起 Pull Request. 配置基于 airbnb-base, typescript-eslint/recommended, vue/recommended 修改而来, 几个比较特殊的规则如下:
- 除了 Vue 单文件组件, 禁止使用 export default, 所有导出必须命名.
- 参数列表, 数组, 对象等的尾随逗号必须添加.
- 如非必要禁止在末尾添加分号.
- 任何控制流语句主体必须添加大括号.
- 一行代码最长 80 字符.
- 不需要使用 this 特性的函数, 均使用箭头函数.
仅提交源代码上的修改即可, 不建议把 dist 文件夹里的产物也提交, 否则容易在 PR 时产生冲突.
commit message 只需写明改动点, 中英文随意, 也不强求类似 commit-lint 的格式.
将你的分支往主仓库的 preview 分支合并就行.
你可以选择不将功能代码合并到主仓库, 因此也没有 ESLint 的限制. PR 时仅添加指向你的仓库中的组件信息即可, 具体来说, 是在 registry/lib/docs/third-party.ts 中, 往对应数组中添加你的功能的相关信息, 当然别忘了把 owner 设为你的 GitHub 用户名.