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 开发者,精准高效
105
代码仓库
GitHub 星标数
10.7K
首次出现
2026年1月21日
安全审计
安装于
opencode95
codex91
gemini-cli89
cursor88
github-copilot86
claude-code81
We less than 150 words description for a PR changes, including new features, bug fixes, and improvements. And if there have APIs break changes (Only crates/ui changes) we should have a section called ## Breaking Changes to list them clearly.
When a pull request introduces breaking changes to a codebase, it's important to clearly communicate these changes to users and developers who rely on the code. A well-written breaking changes description helps ensure that everyone understands what has changed, why it has changed, and how to adapt to the new version.
We can get the changes from the PR diff and summarize them in a clear and concise manner. Aim to provide a clear APIs changes for users to follow.
We pefer the following format for breaking changes descriptions:
diff.## Breaking Changes as the section title.For example:
## Breaking Changes
- Added `id` parameter to `Sidebar::new`.
```diff
- Sidebar::new()
+ Sidebar::new("sidebar")
```
- Removed the `left` and `right` methods; use `side` instead.
> Default is left.
```diff
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
```
Weekly Installs
105
Repository
GitHub Stars
10.7K
First Seen
Jan 21, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykWarn
Installed on
opencode95
codex91
gemini-cli89
cursor88
github-copilot86
claude-code81
agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试
157,400 周安装
GitHub Copilot 代码迁移指令生成器 | 自动分析代码演进与生成转换规则
7,700 周安装
Fabric Lakehouse 使用指南:核心概念、性能优化与数据管理实践
7,700 周安装
EditorConfig 专家 - 自动生成最佳实践配置文件,统一团队代码风格
7,700 周安装
BigQuery流水线审计:成本控制、安全与生产就绪度检查指南
7,700 周安装
AI生成应用商店截图与预览视频工具 - 符合Apple/Google规范,提升应用曝光
7,700 周安装
Google Workspace CLI 研究员角色:高效组织研究、管理参考文献与协作
7,800 周安装