From 295236d90726d5417b1a48f68c0092a9f3af6b84 Mon Sep 17 00:00:00 2001 From: stuartmorgan Date: Wed, 28 Aug 2019 19:58:05 -0700 Subject: [PATCH] Add style guide and formatting information Updates CONTRIBUTING.md with style guide links for the engine languages, as well as a note about auto-formatting. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a9aefa434773..202f4f4e4f9b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,16 @@ the Engine development environment][engine_dev_setup] on our wiki. Those instructions are part of the broader onboarding instructions described in the contributing guide. +### Style + +The Flutter engine follows Google style for the languages it uses: +- [C++](https://google.github.io/styleguide/cppguide.html) +- [Objective-C](https://google.github.io/styleguide/objcguide.html) (including + [Objective-C++](https://google.github.io/styleguide/objcguide.html#objective-c)) +- [Java](https://google.github.io/styleguide/javaguide.html) + +C++ and Objective-C/C++ files are formatted with `clang-format`, and GN files with `gn format`. + [build_status]: https://cirrus-ci.com/github/flutter/engine [code_of_conduct]: https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md [contrib_guide]: https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md