tdesign-react
tdesign-react copied to clipboard
feat(site): add a changelog for each component page
🤔 这个 PR 的性质是?
- [ ] 日常 bug 修复
- [ ] 新特性提交
- [ ] 文档改进
- [ ] 演示代码改进
- [ ] 组件样式/交互改进
- [ ] CI/CD 改进
- [ ] 重构
- [ ] 代码风格优化
- [ ] 测试用例
- [ ] 分支合并
- [x] 其他
🔗 相关 Issue
💡 需求背景和解决方案
需要配合 tdesign-site-component 一起更新
未来发版的 CHANGELOG.md 需要确保符合下面格式,否则 JSON 容易缺失部分内容
- 每条 log 必须出现具体的原始组件名
GlobalConfig统一称为ConfigProvider
- `RadioGroup`: 优化 xxx
+ `Radio`: 优化 `RadioGroup` 的 xxx
- `DateRangePicker`: 修复 xxx
+ `DatePicker`: 修复 `DateRangePicker` 的 xxx
- 支持一行日志涉及多个组件,但确保使用「反引号」包裹所有出现组件名
- Cascader、ColorPicker、DatePicker、TimePicker 新增 xxx 回调
+ `Cascader` 、 `ColorPicker`、 `DatePicker` 、`TimePicker` 新增 xxx 回调
- 如果属于一个组件名开头,后面接着一个子列表,存在多条 log,那么首行,组件名后面必须跟有冒号
:(否则拆分结果会异常)
- `ImageViewer`
- 日志1
- 日志2
+ `ImageViewer`:
- 日志1
- 日志2
- 如果一条 PR 涉及多条变更 log,推荐以下写法
- - 日志1 @用户名 (#1)[PR链接1]
- - 日志2 @用户名 (#1)[PR链接1]
+ - `Table`: @用户名 (#1)[PR链接1]
+ - 日志1
+ - 日志2
(或者同一个贡献者,但不同 PR)
- - 日志1 @用户名 (#1)[PR 链接1]
- - 日志2 @用户名 (#2)[PR 链接2]
+ - `Table`: @用户名
+ - 日志1 (#1)[PR链接1]
+ - 日志2 (#2)[PR链接2]
📝 更新日志
-
feat(site): 每个组件文档页面新增单独的 Changelog
-
[ ] 本条 PR 不需要纳入 Changelog
☑️ 请求合并前的自查清单
⚠️ 请自检并全部勾选全部选项。⚠️
- [x] 文档已补充或无须补充
- [x] 代码演示已提供或无须提供
- [x] TypeScript 定义已补充或无须补充
- [x] Changelog 已提供或无须提供
这样看起来突显的是人,不是修改日志
这样看起来突显的是人,不是修改日志
🤔 这么说也有道理...但原始的 CHANGELOG.md 确实也有很多这种写法。
只不过分类之后去除了组件名前缀,第一行只剩下用户名了,可以再讨论一下 ☑️
旧的日志格式存在问题可以改了他
这样看起来突显的是人,不是修改日志
这个后面查看每个组件哪些有不合理的日志,统一人工修改 CHANGELOG.md 吧
/update-common

这样看起来突显的是人,不是修改日志
这样看起来突显的是人,不是修改日志