CONTRIBUTING.md

Contributing to the Flutter engine

See also: Flutter's code of conduct

Welcome

For an introduction to contributing to Flutter, see our contributor guide.

For specific instructions regarding building Flutter's engine, see Setting up the Engine development environment 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++
  • 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.
• Objective-C (including Objective-C++)
• Java

C/C++ and Objective-C/C++ files are formatted with clang-format, and GN files with gn format.

Fuchsia Contributions from Googlers

Googlers contributing to Fuchsia should follow the additional steps at: go/flutter-fuchsia-pr-policy.