docs: changelog of 1.0.1 #276
Conversation
📝 Walkthrough<details>
<summary>📝 Walkthrough</summary>
## Walkthrough
本次变更更新了版本为1.0.1的变更日志，包含多个增强和修复。主要优化了`useXAgent`和`XStream`的TypeScript类型，`useXChat`中的`agent`参数被设为可选，以支持数据管理功能。调整了`Conversations`组件的样式以符合RICH设计规范，解决了使用`pnpm`时的幽灵依赖问题，展示了附件上传功能的独立模板，更新了文档中的贡献者信息和代码示例，修复了设计文档中的错误链接。此外，更新了`package.json`中的版本号。
## Changes
| 文件 | 更改摘要 |
|-----------------------------|------------------------------------------|
| CHANGELOG.en-US.md | 更新版本1.0.1的变更日志，包含多个增强和修复。 |
| CHANGELOG.zh-CN.md | 更新版本1.0.1的变更日志，包含多个增强和修复。 |
| package.json | 更新版本号从1.0.0到1.0.1，未修改其他配置。 |
## Possibly related PRs
- #271: 该PR使`useXChat`中的`agent`参数变为可选，与本次变更中`XChatConfig`接口的相关更改直接相关。
## Suggested reviewers
- afc163
- MadCcc
> 在兔子洞里跳跃欢快，
> 新版本发布真是精彩！
> 代码优化如春风拂面，
> 附件上传功能更添色彩。
> 让我们一起欢庆这变化，
> 兔子们齐声歌唱，乐无涯！ 🐇✨
</details>Warning Rate limit exceeded@YumoImer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 54 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
CHANGELOG.zh-CN.md (1)
22-33: 建议改进变更日志的组织结构当前的变更记录有以下几点可以优化：
- 对于包含多个 PR 的条目（如第 30-31 行），建议拆分为独立的变更记录，使每个具体改动更清晰。
- 建议按照重要性对变更进行重新排序，将重要的功能改进和 Bug 修复放在前面。
- 部分条目（如第 33 行的"日常维护"）过于笼统，建议具体说明修改内容。
建议按照以下结构重新组织：
- 🛠 日常维护 (#249)(#244)(#220)(#231)(#227)(#228)(#222)(#217) 由 [afc163](https://github.com/afc163)、[zombieJ](https://github.com/zombieJ)、[YumoImer](https://github.com/YumoImer) 完成 + 🛠 优化构建流程 (#249) 由 [afc163](https://github.com/afc163) 提交 + 🛠 重构测试用例 (#244) 由 [zombieJ](https://github.com/zombieJ) 提交 + 🛠 更新依赖版本 (#220, #231) 由 [YumoImer](https://github.com/YumoImer) 提交CHANGELOG.en-US.md (2)
34-34: 建议细化日常维护内容当前的日常维护条目过于笼统，建议将 PRs (#249)(#244)(#220)(#231)(#227)(#228)(#222)(#217) 分别列出具体的改动内容，以便用户更好地了解每个变更的具体影响。
23-33: 变更日志内容完整，建议优化描述变更日志的基本结构和格式正确，但建议对以下几点进行优化：
- 对于 TS 类型优化的条目，建议说明具体改进了哪些类型定义
- 对于性能优化相关的条目（如更新浏览器目标以减少包大小），建议添加具体的改进数据
建议参考以下格式：
- 🛠 Optimized TS types for `useXAgent` and `XStream` (#272) + 🛠 Optimized TS types for `useXAgent` (improved generic constraints) and `XStream` (added missing type exports) (#272) - 📦 Updated browser targets to reduce bundle size (#234) + 📦 Updated browser targets to reduce bundle size by XX% (#234)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
CHANGELOG.en-US.md(1 hunks)CHANGELOG.zh-CN.md(1 hunks)package.json(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- package.json
🔇 Additional comments (2)
CHANGELOG.zh-CN.md (1)
18-20: 版本条目格式正确！
版本号和发布日期的格式符合变更日志的标准规范。
CHANGELOG.en-US.md (1)
19-21: 版本标题格式正确！
版本号和发布日期的格式符合 changelog 的一致性要求。
Deploying ant-design-x with
|
| Latest commit: |
c0400a0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://11b786ef.ant-design-x.pages.dev |
| Branch Preview URL: | https://docs-changelog-1-0-1.ant-design-x.pages.dev |
Bundle ReportBundle size has no change ✅ |
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #276 +/- ##
=======================================
Coverage 91.13% 91.13%
=======================================
Files 66 66
Lines 1422 1422
Branches 379 379
=======================================
Hits 1296 1296
Misses 126 126 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.en-US.md (1)
26-26: 建议改进语法在"Fixed ghost dependency issue"前添加冠词"a"，使语法更加完整。建议修改为：
- 🛠 Fixed ghost dependency issue that prevented the project from starting when using `pnpm`. + 🛠 Fixed a ghost dependency issue that prevented the project from starting when using `pnpm`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Possible missing article found.
Context: ...https://github.com/YumoImer) - 🛠 Fixed ghost dependency issue that prevented the pro...(AI_HYDRA_LEO_MISSING_A)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.en-US.md(1 hunks)CHANGELOG.zh-CN.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.zh-CN.md
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.en-US.md
[uncategorized] ~26-~26: Possible missing article found.
Context: ...https://github.com/YumoImer) - 🛠 Fixed ghost dependency issue that prevented the pro...
(AI_HYDRA_LEO_MISSING_A)
🔇 Additional comments (2)
CHANGELOG.en-US.md (2)
19-21: 版本号和日期格式正确！
版本号遵循语义化版本规范，日期格式与之前的条目保持一致。
23-30: 变更日志条目格式规范！
每个条目都包含了完整的要素：
- 使用表情符号标识变更类型
- 清晰的变更描述
- PR链接
- 贡献者署名
🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Possible missing article found.
Context: ...https://github.com/YumoImer) - 🛠 Fixed ghost dependency issue that prevented the pro...
(AI_HYDRA_LEO_MISSING_A)
Summary by CodeRabbit
新功能
useXChat中的agent参数现为可选，增强了数据管理功能。bug 修复
pnpm时阻碍项目启动的幽灵依赖问题。文档
README.md文件以提高清晰度和完整性。用户体验