TDesign——如何给TDesign提PR

2024-08-15 12:38:26 浏览数 (3)

前言

文档

  • 贡献指北
  • 组件测试
  • wiki

内容

项目配置

目录说明

代码语言:javascript复制
├── examples // 组件文档与 demos
├── script // 构建代码
├── site // 站点代码
├── src // 组件代码
├── test // 测试文件

Fork项目

点击后按着指示操作就好了

克隆项目

克隆你仓库fork的那个哈

代码语言:javascript复制
git clone git@github.com:wangyang0210/tdesign-vue-next.git

安装依赖

代码语言:javascript复制
npm i

初始化子仓库

代码语言:javascript复制
git submodule init
git submodule update

查看issue

issue 传送门 找个顺眼的然后去调试解决~ 说到issue,这里建议提交issue的时候最好给个demo;再不济描述的详细点也行;方面别人排查;

现在我们以date-picker为例子进行下面的操作;

?> 如果不清楚组件信息可以先去官网或者直接查看源码来了解组件的一些信息

创建分支

主仓库遵循使用git flow规范;

代码语言:javascript复制
git checkout -b fix/date-pick_value-type

查找问题

根据下面的报错,我们可以找到对应的文件,然后再搜索valueType属性,然后这个问题其实到这里也就解决了; 如果遇到一些比较复杂的可以进行debugger调式; 如果不确定自己的修改会不会对组件进行破坏性的操作,可以先和code review进行讨论再进行代码编写;

测试

开发时可以只针对自己的组件测试; 提交前建议全部测试下; 这个可以提前看下提交PR可能会遇到的问题;

代码语言:javascript复制
npm run test

提交代码

提交代码前,先确认下自己这些是不是都做了;

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • Changelog 已提供或无须提供

commit的提交信息基于angular 提交规范:

代码语言:javascript复制
git add .srcdate-pickerdate-range-picker-props.ts 
git commit -m "fix(date-picker): date range picker valueType validator"
git push --set-upstream-to origin fix/date-pick_value-type

提交PR

提交完成后,访问Pull Request创建PR就好了;

?> 信息的填写按着模板中的选项结合自身修复的事情进行完善就好了

代码语言:javascript复制
<!--
首先,感谢你的贡献!


	

1 人点赞