-
Notifications
You must be signed in to change notification settings - Fork 814
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NutUI 贡献指南 #1671
Labels
help wanted
问题求助
Comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
NutUI 贡献指南
1、选择参与贡献的议题
2、安装项目依赖
本项目为 pnpm monorepo 仓库,要求使用 pnpm 安装项目依赖。
请注意,仓库中的
pnpm-lock.yaml
可能会定期升级更新,项目启动所依赖的前置脚本文件也可能会有修改,因此建议每次参与贡献前都拉取最新的分支并重新执行以下操作。3、项目开发环境
A、启动文档与 H5(@nutui/nutui) demo
src/packages/__VUE/
index.vue
doc.md
doc.en-US.md
demo.vue
或者demo/index.vue
B、运行 Taro(@nutui/nutui-taro) demo
src/packages/__VUE/
index.taro.vue
doc.taro.md
packages/nutui-taro-demo
4、项目构建
5、在 PR 提交前
所有代码改动在进行 commit 之前都应该通过以下测试:
在 commit 时,仓库会自动进行 prettier 格式化以及 eslint 自动修复。
若 commit 提交失败,请再次执行上面的命令,确保可以顺序通过后再提交。
6、PR 提交后
GitHub Action 将会自动进行以下 Job
必须通过:
建议通过:
其他内容
1、单元测试覆盖率
可以通过
pnpm test:c
执行测试并生成单元测试覆盖率数据。2、文档中演示代码与 demo 源码之间的映射关系
> demo: button plain
-->src/packages/__VUE/button/demo/plain.vue
> demo: button plain basic
-->packages/nutui-taro-demo/src/basic/pages/button/plain.vue
The text was updated successfully, but these errors were encountered: