Skip to content

Commit 7f3e6ae

Browse files
chenx97MingcongBai
authored andcommitted
fix(package-styling-manual): update messages based on real commits
Multiple lines fail to match our modern practices.
1 parent 02d64cb commit 7f3e6ae

File tree

2 files changed

+10
-20
lines changed

2 files changed

+10
-20
lines changed

content/developer/packaging/package-styling-manual.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -287,13 +287,11 @@ When committing (or contributing, if you like) to the [AOSC OS ABBS Tree](https:
287287
| Action | Message Formatting | Sample Commit Message |
288288
|-----------|-----------------------------------|-----------------------------------------|
289289
| Introducing a new package | `$PKGNAME: new, $PKGVER` | `windowsnt-kernel: new, 5.1.2600` |
290-
| Security fixes with version update | `$PKGNAME: update to $PKGVER; #NNN` | `bash: update to 5.2; #114514`, where `#114514` is a reference to the original security report (GitHub issue) |
291-
| Security fixes without version update, utilising distribution patch(es) | `$PKGNAME: ($DISTNAME patch[es], $CHANNEL) #NNN` | `gnome-shell: (Ubuntu patches, 18.10) #2333`, where `#2333` is a reference to the original security report (GitHub issue) |
292-
| Security fixes without version update, utilising upstream patch(es) | `$PKGNAME: (upstream patch[es]) #NNN` | `audacious: (upstream patches) #1919`, where `#1919` is a reference to the original security report (GitHub issue) |
290+
| Security fixes with version update | `$PKGNAME: security update to $PKGVER` | `firefox: security update to 142.0`, and link the original security report (GitHub issue) to the associated GitHub PR in the Development sidemenu |
291+
| Security fixes without version update, utilising patch(es) | `$PKGNAME: fix $CVEID` | `samba: fix CVE-2025-0620`, and link the original security report (GitHub issue) to the associated GitHub PR in the Development sidemenu |
293292
| Updating a package | `$PKGNAME: update to $PKGVER` | `mate-desktop: update to 1.22.0` |
294293
| Work-in-progress with a fail-to-build package | `$PKGNAME: ... (FTBFS)` | `chromeos-desktop: update to 99.0.9999 (FTBFS)`, note that "FTBFS" stands for "Failed To Build From Source", this term is used loosely |
295294
| Working with a package | `$PKGNAME: ...` | `kde-workspace: add qt-5 dependency`, just say what you did in present tense |
296-
| Working with a package, multiple actions | `$PKGNAME: ...; ...` | `gnome-shell: add at-spi2-core dependency; update to 3.32.0` |
297295
| Working with a package, utilising distribution patch(es) | `$PKGNAME: ($DISTNAME patch[es], $CHANNEL) ...` | `qt-4: (Arch Linux patches) rebuild for openssl` |
298296
| Working with a package, utilising upstream patch(es) | `$PKGNAME: (upstream patch[es]) ...` | `kodi: (upstream patch) fix lock-up on start-up` |
299297
| Working with a QA issue | `$PKGNAME: ... ($ISSUECODE)` | `psiconv: rebuild for imagemagick (E431)`, for a list of QA issue codes, refer to this [list](@/developer/packaging/qa-issue-codes.md) |
@@ -305,13 +303,10 @@ When committing (or contributing, if you like) to the [AOSC OS ABBS Tree](https:
305303

306304
## Long Messages
307305

308-
When more than one of the actions were committed, and that the short message goes beyond 50 characters (including space and punctuation marks), you should utilise a "long Git commit message", for example:
306+
When more than one of the actions were committed, or that the short message goes beyond 50 characters (including space and punctuation marks), you should utilise a "long Git commit message", for example:
309307

310308
```
311-
firefox: update to 64.0.2; #1536
309+
syncthing: update to 2.0.3
312310
313-
- Enable PGO on AMD64, patches from Fedora and upstream.
314-
- Clean up defines.
315-
- Remove deprecated --enable-pie option.
316-
- More vendor-specific preferences to further limit Pocket integration and telemetry.
311+
- Use gomod template to build.
317312
```

content/developer/packaging/package-styling-manual.zh.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,11 @@ Electron、Chromium 和基于它们的软件包应该按照下面的要求放置
285285
| 情形 | 格式要求 | 举例 |
286286
|-----------|-----------------------------------|-----------------------------------------|
287287
| 引入新的软件包 | `$PKGNAME: new, $PKGVER` | `windowsnt-kernel: new, 5.1.2600` |
288-
| 版本更新(安全更新) | `$PKGNAME: update to $PKGVER; #NNN` | `bash: update to 5.2; #114514`,其中 `#114514` 指向对应的 GitHub issue |
289-
| 非版本更新(安全更新,使用发行版补丁) | `$PKGNAME: ($DISTNAME patch[es], $CHANNEL) #NNN` | `gnome-shell: (Ubuntu patches, 18.10) #2333`,其中 `#2333` 指向对应的 GitHub issue |
290-
| 非版本更新(安全更新,使用上游补丁) | `$PKGNAME: (upstream patch[es]) #NNN` | `audacious: (upstream patches) #1919`,其中 `#1919` 指向对应的 GitHub issue |
288+
| 版本更新(安全更新) | `$PKGNAME: security update to $PKGVER` | `firefox: security update to 142.0`,并在该提交所属 GitHub PR 的 Development 侧边栏中勾选对应的安全更新工单(GitHub Issue) |
289+
| 非版本更新(安全更新,使用补丁) | `$PKGNAME: fix $CVEID` | `samba: fix CVE-2025-0620`,并在该提交所属 GitHub PR 的 Development 侧边栏中勾选对应的安全更新工单(GitHub Issue) |
291290
| 版本更新 | `$PKGNAME: update to $PKGVER` | `mate-desktop: update to 1.22.0` |
292291
| 软件构建失败 | `$PKGNAME: ... (FTBFS)` | `chromeos-desktop: update to 99.0.9999 (FTBFS)`,FTBFS 是 Failed To Build From Source 的简写 |
293292
| 软件包改动(单处) | `$PKGNAME: ...` | `kde-workspace: add qt-5 dependency`,使用一般现在时即可 |
294-
| 软件包改动(多处) | `$PKGNAME: ...; ...` | `gnome-shell: add at-spi2-core dependency; update to 3.32.0` |
295293
| 软件包改动(使用发行版补丁) | `$PKGNAME: ($DISTNAME patch[es], $CHANNEL) ...` | `qt-4: (Arch Linux patches) rebuild for openssl` |
296294
| 软件包改动(使用上游补丁) | `$PKGNAME: (upstream patch[es]) ...` | `kodi: (upstream patch) fix lock-up on start-up` |
297295
| QA 问题 | `$PKGNAME: ... ($ISSUECODE)` | `psiconv: rebuild for imagemagick (E431)`,请阅读 [这个清单](@/developer/packaging/qa-issue-codes.md) 了解各个 `$ISSUECODE` 对应的含义 |
@@ -303,13 +301,10 @@ Electron、Chromium 和基于它们的软件包应该按照下面的要求放置
303301

304302
## 长消息
305303

306-
如果您的提交信息超过 50 个字符(包括空格和标点符号),则应该使用下面的格式撰写长消息:
304+
如果您的提交信息超过 50 个字符(包括空格和标点符号),或者在一个提交中进行了多处改动,则应该使用下面的格式撰写长消息:
307305

308306
```
309-
firefox: update to 64.0.2; #1536
307+
syncthing: update to 2.0.3
310308
311-
- Enable PGO on AMD64, patches from Fedora and upstream.
312-
- Clean up defines.
313-
- Remove deprecated --enable-pie option.
314-
- More vendor-specific preferences to further limit Pocket integration and telemetry.
309+
- Use gomod template to build.
315310
```

0 commit comments

Comments
 (0)