diff --git a/engine/src/flutter/CONTRIBUTING.md b/engine/src/flutter/CONTRIBUTING.md index 479bc23eae3..0bc5f7cf170 100644 --- a/engine/src/flutter/CONTRIBUTING.md +++ b/engine/src/flutter/CONTRIBUTING.md @@ -1,10 +1,8 @@ -Contributing to the Flutter engine -================================== +# Contributing to the Flutter engine _See also: [Flutter's code of conduct][code_of_conduct]_ -Welcome -------- +## Welcome For an introduction to contributing to Flutter, see [our contributor guide][contrib_guide]. @@ -14,25 +12,25 @@ 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 +## Style The Flutter engine follows Google style for the languages it uses: + - [C++](https://google.github.io/styleguide/cppguide.html) - **Note**: The Linux embedding generally follows idiomatic GObject-based C style. Use of C++ is discouraged in that embedding to avoid creating hybrid code that feels unfamiliar to either developers used to working with `GObject` or C++ developers. For example, do not use STL collections or `std::string`. Exceptions: - - C-style casts are forbidden; use C++ casts. - - Use `nullptr` rather than `NULL`. - - Avoid `#define`; for internal constants use `static constexpr` instead. + - C-style casts are forbidden; use C++ casts. + - Use `nullptr` rather than `NULL`. + - Avoid `#define`; for internal constants use `static constexpr` instead. - [Objective-C][objc_style] (including [Objective-C++][objcc_style]) - [Java][java_style] C/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 [engine_dev_setup]: https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment @@ -40,8 +38,7 @@ with `gn format`. [objcc_style]: https://google.github.io/styleguide/objcguide.html#objective-c [java_style]: https://google.github.io/styleguide/javaguide.html - -### Fuchsia Contributions from Googlers +## Fuchsia Contributions from Googlers Googlers contributing to Fuchsia should follow the additional steps at: go/flutter-fuchsia-pr-policy.