mirror of
https://github.com/ant-design/ant-design.git
synced 2025-06-11 19:42:54 +08:00
79425c5dc1
* feat: add cursor rules in .cursor/rules * docs: add non-component changelog rule * docs: update cursor rules format * feat: update cursor rules * refactor: remove duplicated styles.mdc * Apply suggestions from code review Signed-off-by: afc163 <afc163@gmail.com> * Apply suggestions from code review Signed-off-by: afc163 <afc163@gmail.com> * Delete .cursor/rules/component.mdc Signed-off-by: afc163 <afc163@gmail.com> * Apply suggestions from code review Signed-off-by: afc163 <afc163@gmail.com> * Delete pr_template.txt Signed-off-by: afc163 <afc163@gmail.com> * Delete .cursorrules Signed-off-by: afc163 <afc163@gmail.com> * Apply suggestions from code review Signed-off-by: afc163 <afc163@gmail.com> * Update .cursor/rules/project.mdc Signed-off-by: afc163 <afc163@gmail.com> * Update project.mdc Signed-off-by: afc163 <afc163@gmail.com> * Delete .cursor/rules/implementation.mdc Signed-off-by: afc163 <afc163@gmail.com> * Update project.mdc Signed-off-by: afc163 <afc163@gmail.com> * Apply suggestions from code review Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> Signed-off-by: afc163 <afc163@gmail.com> * feat: add server-side rendering guidelines * update * update --------- Signed-off-by: afc163 <afc163@gmail.com> Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
61 lines
2.2 KiB
Plaintext
61 lines
2.2 KiB
Plaintext
---
|
||
description: 规范项目文档和 Changelog
|
||
globs: ["**/CHANGELOG*.md", "components/**/index.*.md"]
|
||
alwaysApply: false
|
||
---
|
||
# 文档和 Changelog 规范
|
||
|
||
## 基本要求
|
||
|
||
- 提供中英文两个版本
|
||
- 新的属性需要声明可用的版本号
|
||
- 属性命名符合 antd 的 API 命名规则：https://github.com/ant-design/ant-design/wiki/API-Naming-rules
|
||
|
||
## Changelog 规范
|
||
|
||
- 在 CHANGELOG.en-US.md 和 CHANGELOG.zh-CN.md 书写每个版本的变更
|
||
- 对用户使用上无感知的改动建议（文档修补、微小的样式优化、代码风格重构等等）不要提及，保持 CHANGELOG 的内容有效性
|
||
- 非 antd 组件的改动（如工程化、构建工具、开发流程等）在 changelog 区块中写 "-"
|
||
- 用面向开发者的角度和叙述方式撰写 CHANGELOG，不描述修复细节，描述问题和对开发者的影响；描述用户的原始问题，而非你的解决方式
|
||
|
||
### 示例
|
||
|
||
- 不好的例子：修复组件 Typography 的 dom 结构问题
|
||
- 好的例子：修复了 List.Item 中内容空格丢失的问题
|
||
|
||
### 其他要求
|
||
|
||
- 新增属性时，建议用易于理解的语言补充描述用户可以感知的变化
|
||
- 尽量给出原始的 PR 链接，社区提交的 PR 改动加上提交者的链接
|
||
- 底层模块升级中间版本要去 rc-component 里找到改动，给出变动说明
|
||
- 建议参考之前版本的日志写法
|
||
- 将同组件的改动放在一起，内容子级缩进
|
||
|
||
### Changelog Emoji 规范
|
||
|
||
- 🐞 Bug 修复
|
||
- 💄 样式更新或 token 更新
|
||
- 🆕 新增特性，新增属性
|
||
- 🔥 极其值得关注的新增特性
|
||
- 🇺🇸🇨🇳🇬🇧 国际化改动
|
||
- 📖 📝 文档或网站改进
|
||
- ✅ 新增或更新测试用例
|
||
- 🛎 更新警告/提示信息
|
||
- ⌨️ ♿ 可访问性增强
|
||
- 🗑 废弃或移除
|
||
- 🛠 重构或工具链优化
|
||
- ⚡️ 性能提升
|
||
|
||
# 文档规范
|
||
|
||
- 提供中英文两个版本
|
||
- 新属性需声明可用的版本号
|
||
- 属性命名符合 API 命名规则
|
||
- 组件文档包含：使用场景、基础用法、API 说明
|
||
- 文档示例应简洁明了
|
||
- 属性的描述应清晰易懂
|
||
- 对复杂功能提供详细说明
|
||
- 加入 TypeScript 定义
|
||
- 提供常见问题解答
|
||
- 更新文档时同步更新中英文版本
|