mirror of
https://github.com/encounter/engine.git
synced 2026-03-30 11:09:55 -07:00
stuartmorgan
e2810dcfb9
Updates CONTRIBUTING.md with style guide links for the engine languages, as well as a note about auto-formatting.
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
Contributing to the Flutter engine
|
|
==================================
|
|
|
|
[][build_status]
|
|
|
|
_See also: [Flutter's code of conduct][code_of_conduct]_
|
|
|
|
Welcome
|
|
-------
|
|
|
|
For an introduction to contributing to Flutter, see [our contributor
|
|
guide][contrib_guide].
|
|
|
|
For specific instructions regarding building Flutter's engine, see [Setting up
|
|
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
|
|
[engine_dev_setup]: https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment
|