CONTRIBUTING.md 1.5 KB
Newer Older
1 2
Contributing to the Flutter engine
==================================
A
Adam Barth 已提交
3

4
[![Build Status](https://api.cirrus-ci.com/github/flutter/engine.svg)][build_status]
A
Adam Barth 已提交
5

6
_See also: [Flutter's code of conduct][code_of_conduct]_
I
Ian Hickson 已提交
7 8 9 10

Welcome
-------

11 12
For an introduction to contributing to Flutter, see [our contributor
guide][contrib_guide].
I
Ian Hickson 已提交
13

14 15 16 17 18
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.

19 20 21 22 23 24 25 26 27 28
### 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`.

29
[build_status]: https://cirrus-ci.com/github/flutter/engine
30
[code_of_conduct]: https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md
31
[contrib_guide]: https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md
32
[engine_dev_setup]: https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment
33 34 35 36

### Fuchsia Contributions from Googlers

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