GitHub PR描述生成器 - 自动生成Pull Request描述与破坏性变更说明
github-pull-request-description by longbridge/gpui-component
安装命令
npx skills add https://github.com/longbridge/gpui-component --skill github-pull-request-description🇨🇳中文介绍
描述
我们为 PR 变更提供少于 150 字的描述，包括新功能、错误修复和改进。如果存在 API 破坏性变更（仅限 crates/ui 变更），我们应该有一个名为 ## 破坏性变更 的部分来清晰地列出它们。
破坏性变更描述
当拉取请求对代码库引入破坏性变更时，向依赖该代码的用户和开发者清晰地传达这些变更非常重要。一个编写良好的破坏性变更描述有助于确保每个人都理解发生了什么变化、为什么变化以及如何适应新版本。
我们可以从 PR 差异中获取变更，并以清晰简洁的方式进行总结。旨在为用户提供清晰的 API 变更以供遵循。
格式
我们更倾向于以下格式来描述破坏性变更：
- 每个破坏性变更项使用项目符号列表。
- 每个项目应有标题和一个使用
diff显示新旧用法的代码块。 - 使用
## 破坏性变更作为章节标题。 - 使用英语。
例如：
## 破坏性变更
- 向 `Sidebar::new` 添加了 `id` 参数。
```diff
- Sidebar::new()
+ Sidebar::new("sidebar")
```
- 移除了 `left` 和 `right` 方法；请改用 `side`。
> 默认为左侧。
```diff
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
```
每周安装量
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
