From fa22d0a87a7267d44443d722c2886f8c6f5a8102 Mon Sep 17 00:00:00 2001 From: Noel O'Brien Date: Thu, 26 Mar 2026 10:35:13 -0700 Subject: [PATCH] docs: add commit message example (#19134) Fixes #19133 Signed-off-by: Noel O'Brien --- docs/commit-messages.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/commit-messages.md b/docs/commit-messages.md index b617e1fad..832a4cc9e 100644 --- a/docs/commit-messages.md +++ b/docs/commit-messages.md @@ -43,13 +43,14 @@ Notably, for the subject (the first line of description): Examples: - | Good Example | notes | - | ------- | --- | - | `foo/bar: fix memory leak` | | - | `foo/bar: bump deps` | | - | `foo/bar: temporarily restrict access` | adverbs are okay | - | `foo/bar: implement new UI design` | | - | `control/{foo,bar}: optimize bar` | feel free to use {foo,bar} for common subpackages| + | Good Example | notes | + |----------------------------------------|---------------------------------------------------| + | `foo/bar: fix memory leak` | | + | `foo/bar: bump deps` | | + | `foo/bar: temporarily restrict access` | adverbs are okay | + | `foo/bar: implement new UI design` | | + | `control/{foo,bar}: optimize bar` | feel free to use {foo,bar} for common subpackages | + | `control,docs: document control usage` | multiple top-level packages are affected | | Bad Example | notes | | ------- | --- |