issue-writing

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Issue and PR Writing

Issue与PR撰写

Write issue, pull request, and merge request titles, bodies, and comments for GitHub, GitLab, and similar platforms. Keep the wording concise, accurate, calm, skeptical, and human. Prefer concrete context over boilerplate, and use platform-neutral wording unless the user or surrounding context calls for platform-specific terms.

为GitHub、GitLab及类似平台撰写Issue、Pull Request和Merge Request的标题、正文及评论。措辞需简洁、准确、冷静、严谨且符合口语化表达。优先使用具体语境而非模板化内容，除非用户或上下文要求，否则采用平台中立的表述。

Writing rules

撰写规则

For English prose, follow these style guides, and apply their language-agnostic rules to prose in any language:
- The Elements of Style
- The Sense of Style
- Chicago Manual of Style
Use consistent formatting within the same response.
Insert spaces between English words and CJK characters.
Use
```
- 
```
(hyphen plus space) for unordered list items; never use
```
*
```
or
```
+
```
.
Use
```
_italics_
```
for italics and
```
**bold**
```
for bold.
Avoid horizontal dividers (
```
<hr>
```
or
```
---
```
); never place them immediately before or after headings.
Never number headings (e.g.,
```
## About me
```
, not
```
## 1. About me
```
).
For list items, omit the trailing period when all items are fragments; if any item is a complete sentence, end every item with a period.

英文文案需遵循以下风格指南，且其语言无关规则适用于任何语言的文案：
- 《The Elements of Style》
- 《The Sense of Style》
- 《Chicago Manual of Style》
同一回复内使用一致的格式。
英文单词与中日韩字符之间需添加空格。
无序列表项使用
```
- 
```
（连字符加空格）；禁止使用
```
*
```
或
```
+
```
。
斜体使用
```
_italics_
```
，粗体使用
```
**bold**
```
。
避免使用水平分隔线（
```
<hr>
```
或
```
---
```
）；切勿将其直接置于标题前后。
标题切勿编号（例如：
```
## About me
```
，而非
```
## 1. About me
```
）。
对于列表项，若所有项均为片段，则省略末尾句号；若有任何项为完整句子，则所有项均需以句号结尾。

Formatting rules

格式规则

Titles

标题

Issue titles use "Sentence case" (capitalize the first word only).
Pull request and merge request titles use Conventional Commits format, following the
```
git-commit
```
skill:
```
<type>[optional scope]: <description>
```

Issue标题采用「句首大写」格式（仅首单词大写）。
Pull Request和Merge Request标题采用Conventional Commits格式，遵循
```
git-commit
```
技能规范：
```
<type>[可选范围]: <描述>
```

Body headings

正文标题

Use headings only when they add structural clarity.
When headings are useful, skip
```
#
```
and
```
##
```
; start visible section headings at
```
###
```
so they do not render too large.
Do not force the text to begin with a heading. Even when headings are useful, a short opening sentence or paragraph can come first.

仅当标题能提升结构清晰度时才使用。
当需要使用标题时，跳过
```
#
```
和
```
##
```
；从
```
###
```
开始使用可见章节标题，避免渲染过大。
无需强制文本以标题开头。即使使用标题，也可先添加简短的开篇句子或段落。

Quality bar

质量标准

Keep it concise. If it does not fit on one screen, it is too long.
State the issue, request, or purpose clearly. Explain why it matters. Include concrete evidence.

保持简洁。内容超过一屏长度即为过长。
清晰说明问题、请求或目的。解释其重要性。包含具体证据。