From 11174e7058f73cd763f4bc614cbfc057d5a0c1db Mon Sep 17 00:00:00 2001 From: Emil Lundmark Date: Fri, 1 Jul 2022 10:00:11 +0200 Subject: [PATCH] Clarify how to reference WebRTC bugs in TODOs Bug: None No-Try: true Change-Id: Iaa8b57dea096ef0588979faa5ba7c22dcff1dada Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/267282 Reviewed-by: Danil Chapovalov Commit-Queue: Emil Lundmark Cr-Commit-Position: refs/heads/main@{#37387} --- g3doc/style-guide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/g3doc/style-guide.md b/g3doc/style-guide.md index 421a7d9dc7..9d713c68c9 100644 --- a/g3doc/style-guide.md +++ b/g3doc/style-guide.md @@ -62,12 +62,14 @@ in definitions for everything they declare. ### `TODO` comments Follow the [Google styleguide for `TODO` comments][goog-style-todo]. When -referencing a WebRTC bug, prefer the url form, e.g. +referencing a WebRTC bug, prefer using the URL form (excluding the scheme part): ```cpp // TODO(bugs.webrtc.org/12345): Delete the hack when blocking bugs are resolved. ``` +The short form used in commit messages, e.g. `webrtc:12345`, is discouraged. + [goog-style-todo]: https://google.github.io/styleguide/cppguide.html#TODO_Comments ### Deprecation