docs: add commit message example (#19134)

Fixes #19133 Signed-off-by: Noel O'Brien <noel@tailscale.com>
3 weeks ago · fa22d0a87a
parent 45f989f52a
commit fa22d0a87a
1 changed files with 8 additions and 7 deletions
--- a/docs/commit-messages.md
+++ b/docs/commit-messages.md
@ -44,12 +44,13 @@ 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 |
+  | `control,docs: document control usage` | multiple top-level packages are affected          |

  | Bad Example | notes |
  | ------- | --- |