From bb821e28b12544832d6198c853c1641b962e542e Mon Sep 17 00:00:00 2001 From: Karl Wiberg Date: Sun, 3 Sep 2017 05:02:12 +0200 Subject: [PATCH] Add a bare-bones C++ style guide BUG=none NOTRY=true Change-Id: I4488aff47db2b9220985156c5112db6d5a79a18e Reviewed-on: https://chromium-review.googlesource.com/641872 Commit-Queue: Karl Wiberg Reviewed-by: Niels Moller Reviewed-by: Danil Chapovalov Cr-Commit-Position: refs/heads/master@{#19645} --- OWNERS | 2 ++ README.md | 2 ++ style-guide.md | 16 ++++++++++++++++ 3 files changed, 20 insertions(+) create mode 100644 style-guide.md diff --git a/OWNERS b/OWNERS index 6e35adfc8a..8cc9d358a9 100644 --- a/OWNERS +++ b/OWNERS @@ -12,3 +12,5 @@ per-file BUILD.gn=kjellander@webrtc.org per-file DEPS=* per-file pylintrc=kjellander@webrtc.org per-file WATCHLISTS=* +per-file style-guide.md=danilchap@webrtc.org +per-file style-guide.md=kwiberg@webrtc.org diff --git a/README.md b/README.md index eeabfc6a87..5c9ea2324a 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,5 @@ started developing with the native code. * Samples and reference apps: https://github.com/webrtc * Mailing list: http://groups.google.com/group/discuss-webrtc * Continuous build: http://build.chromium.org/p/client.webrtc + * [Coding style guide](style-guide.md) + * [Code of conduct](CODE_OF_CONDUCT.md) diff --git a/style-guide.md b/style-guide.md new file mode 100644 index 0000000000..6cf5f4589b --- /dev/null +++ b/style-guide.md @@ -0,0 +1,16 @@ +# WebRTC coding style guide + +## C++ + +WebRTC follows the [Chromium][chr-style] and [Google][goog-style] C++ +style guides, unless an exception is listed below. In cases where they +conflict, the Chromium style guide trumps the Google style guide, and +the exceptions in this file trump them both. + +[chr-style]: https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md +[goog-style]: https://google.github.io/styleguide/cppguide.html + +### Exceptions + +There are no exceptions yet. If and when exceptions are adopted, +they'll be listed here.