From 375eff4f0404b08aeadc36140f7c0415a4247080 Mon Sep 17 00:00:00 2001 From: Danil Chapovalov Date: Wed, 11 Dec 2019 12:45:08 +0100 Subject: [PATCH] Add guidance to style guide how to reference a bug in a TODO Bug: None Change-Id: Icfbce347d0c2a71fd728507e5005eb05736b13a1 No-Try: True Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/161733 Reviewed-by: Karl Wiberg Commit-Queue: Danil Chapovalov Cr-Commit-Position: refs/heads/master@{#30058} --- style-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/style-guide.md b/style-guide.md index 8289f261dd..901217a86d 100644 --- a/style-guide.md +++ b/style-guide.md @@ -61,6 +61,16 @@ declare. [Examples and exceptions](style-guide/h-cc-pairs.md). +### TODO comments + +Follow the [Google style][goog-style-todo]. When referencing a WebRTC bug, +prefer the url form, e.g. +``` +// TODO(bugs.webrtc.org/12345): Delete the hack when blocking bugs are resolved. +``` + +[goog-style-todo]: https://google.github.io/styleguide/cppguide.html#TODO_Comments + ### ArrayView When passing an array of values to a function, use `rtc::ArrayView`