issue-pr-writing

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Issue and PR Writing

Issue与PR撰写

Purpose

目的

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 the Chicago Manual of Style.
Use consistent formatting within the same response.
Insert spaces between English words and CJK characters.
Always specify the language for syntax highlighting when using fenced code blocks.
Use
```
- 
```
(hyphen plus space) for unordered list items; never use
```
*
```
or
```
+
```
.
Use
```
_italics_
```
for italics and
```
**bold**
```
for bold.
Never number headings (e.g.,
```
## About me
```
, not
```
## 1. About me
```
).
Never use horizontal dividers (
```
<hr>
```
or
```
---
```
) between headings.
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.

英文文案遵循《芝加哥手册》（Chicago Manual of Style）规范。
在同一回复中使用统一的格式。
英文单词与中日韩（CJK）字符之间需添加空格。
使用围栏代码块时，务必指定语法高亮的语言。
无序列表项使用
```
- 
```
（连字符加空格），禁止使用
```
*
```
或
```
+
```
。
使用
```
_italics_
```
表示斜体，
```
**bold**
```
表示粗体。
标题禁止编号（例如，使用
```
## About me
```
，而非
```
## 1. About me
```
）。
标题之间禁止使用水平分隔线（
```
<hr>
```
或
```
---
```
）。
对于列表项：若所有项均为片段，省略末尾句号；若存在完整句子，则所有项均需以句号结尾。

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.

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