Skip to content

Commit

Permalink
Add style guide and formatting information (#11669)
Browse files Browse the repository at this point in the history
Updates CONTRIBUTING.md with style guide links for the engine languages, as well as a note about auto-formatting.
  • Loading branch information
stuartmorgan authored Sep 4, 2019
1 parent 74cedf2 commit e2810dc
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e2810dc

Please sign in to comment.