Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit e2810dc

Browse files
Add style guide and formatting information (#11669)
Updates CONTRIBUTING.md with style guide links for the engine languages, as well as a note about auto-formatting.
1 parent 74cedf2 commit e2810dc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ the Engine development environment][engine_dev_setup] on our wiki. Those
1616
instructions are part of the broader onboarding instructions described in the
1717
contributing guide.
1818

19+
### Style
20+
21+
The Flutter engine follows Google style for the languages it uses:
22+
- [C++](https://google.github.io/styleguide/cppguide.html)
23+
- [Objective-C](https://google.github.io/styleguide/objcguide.html) (including
24+
[Objective-C++](https://google.github.io/styleguide/objcguide.html#objective-c))
25+
- [Java](https://google.github.io/styleguide/javaguide.html)
26+
27+
C++ and Objective-C/C++ files are formatted with `clang-format`, and GN files with `gn format`.
28+
1929
[build_status]: https://cirrus-ci.com/github/flutter/engine
2030
[code_of_conduct]: https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md
2131
[contrib_guide]: https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)