mollyim/webrtc
1
0
Fork 0
mirror of https://github.com/mollyim/webrtc.git synced 2025-05-12 21:30:45 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify how to reference WebRTC bugs in TODOs

Browse source 
Bug: None
No-Try: true
Change-Id: Iaa8b57dea096ef0588979faa5ba7c22dcff1dada
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/267282
Reviewed-by: Danil Chapovalov <danilchap@webrtc.org>
Commit-Queue: Emil Lundmark <lndmrk@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#37387}
This commit is contained in:
Emil Lundmark 2022-07-01 10:00:11 +02:00 committed by WebRTC LUCI CQ
parent 0b655cbef7
commit 11174e7058
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
g3doc/style-guide.md
View file

@ -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