github-pull-request-description

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Description

描述说明

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.

我们需要为拉取请求（PR）变更撰写不超过150字的描述，涵盖新功能、Bug修复和优化内容。如果存在API破坏性变更（仅限

crates/ui

相关变更），我们应添加一个名为

## Breaking Changes

的章节来清晰列出这些变更。

Breaking changes description

破坏性变更描述

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.

当拉取请求（Pull Request）对代码库引入破坏性变更时，向依赖该代码的用户和开发者清晰传达这些变更至关重要。一份撰写良好的破坏性变更说明有助于确保所有人都了解变更内容、变更原因以及如何适配新版本。

我们可以从PR的diff中提取变更内容，以清晰简洁的方式进行总结。目标是为用户提供明确的API变更指引，方便他们跟进。

Format

格式

We pefer the following format for breaking changes descriptions:

Use bullet list for each breaking change item.
Each item should have title and a code block showing the old and new usage by use
```
diff
```
.
Use
```
## Breaking Changes
```
as the section title.
Use english language.

For example:

undefined

我们偏好以下格式来撰写破坏性变更说明：

每个破坏性变更项使用项目符号列表呈现。
每个条目应包含标题，并使用
```
diff
```
代码块展示新旧用法对比。
使用
```
## Breaking Changes
```
作为章节标题。
使用英文撰写。

示例：

undefined

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)

undefined

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)

undefined