docs: add commit message example (#19134)

Fixes #19133

Signed-off-by: Noel O'Brien <noel@tailscale.com>
main
Noel O'Brien 3 weeks ago committed by GitHub
parent 45f989f52a
commit fa22d0a87a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 15
      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 |
| ------- | --- |

Loading…
Cancel
Save