TDesign——如何给TDesign提PR

发布时间 2023-04-15 16:23:36作者: 。思索

前言

文档

内容

项目配置

目录说明

├── examples // 组件文档与 demos
├── script // 构建代码
├── site // 站点代码
├── src // 组件代码
├── test // 测试文件

Fork项目

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

克隆项目

克隆你仓库fork的那个哈

git clone git@github.com:wangyang0210/tdesign-vue-next.git

安装依赖

npm i

初始化子仓库

git submodule init
git submodule update

查看issue

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

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

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

创建分支

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

git checkout -b fix/date-pick_value-type

查找问题

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

测试

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

npm run test

提交代码

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

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

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

git add .\src\date-picker\date-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就好了;

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

<!--
首先,感谢你的贡献!?
请阅读并遵循 [TDesign 贡献指南](https://github.com/Tencent/tdesign/blob/main/docs/contributing.md),填写以下 pull request 的信息。
PR 在维护者审核通过后会合并,谢谢!
-->

### ? 这个 PR 的性质是?

- [x] 日常 bug 修复
- [ ] 新特性提交
- [ ] 文档改进
- [ ] 演示代码改进
- [ ] 组件样式/交互改进
- [ ] CI/CD 改进
- [ ] 重构
- [ ] 代码风格优化
- [ ] 测试用例
- [ ] 分支合并
- [ ] 其他

### ? 相关 Issue
#2719 
<!--
1. 描述相关需求的来源,如相关的 issue 讨论链接。
-->

### ? 需求背景和解决方案

<!--
1. 要解决的具体问题。
2. 列出最终的 API 实现和用法。
3. 涉及UI/交互变动需要有截图或 GIF。
-->

### ? 更新日志

<!--
从用户角度描述具体变化,以及可能的 breaking change 和其他风险。
-->

fix(date-picker): date range picker valueType validator

- [ ] 本条 PR 不需要纳入 Changelog

### ☑️ 请求合并前的自查清单

⚠️ 请自检并全部**勾选全部选项**。⚠️

- [x] 文档已补充或无须补充
- [x] 代码演示已提供或无须提供
- [x] TypeScript 定义已补充或无须补充
- [x] Changelog 已提供或无须提供

最后就是等待code review了