GitHubPullRequest描述编写Skill github-pull-request-description

---

name: github-pull-request-description description: 编写GitHub Pull Request的描述。

描述

我们使用少于150字的描述来总结PR的变更，包括新功能、bug修复和改进。如果存在API破坏性变化（仅限crates/ui变化），我们应该有一个名为## Breaking Changes的部分来清晰列出它们。

破坏性变化描述

当Pull Request引入代码库的破坏性变化时，重要的是清晰地传达这些变化给依赖该代码的用户和开发者。一个良好编写的破坏性变化描述有助于确保每个人都理解发生了什么变化、为什么变化以及如何适应新版本。

我们可以从PR差异中获取变更，并以清晰简洁的方式总结它们。旨在为用户提供清晰的API变化说明。

格式

我们偏好以下格式用于破坏性变化描述：

1. 为每个破坏性变化项目使用项目符号列表。
2. 每个项目应有标题和代码块，使用diff显示旧用法和新用法。
3. 使用## Breaking Changes作为部分标题。
4. 使用英语语言。

例如：

## Breaking Changes

- 向`Sidebar::new`添加了`id`参数。

```diff
- Sidebar::new()
+ Sidebar::new("sidebar")
```

- 移除了`left`和`right`方法；使用`side`代替。
  > 默认是左侧。

```diff
- Sidebar::right()
+ Sidebar::new("sidebar").side(Side::Right)
```